From 5b0d992bf516e1169169e7f83ca9bed0d79ba589 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 20 Jun 2025 11:06:24 -0700 Subject: [PATCH 1/3] sentence case headers --- mcp.mdx | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/mcp.mdx b/mcp.mdx index eda9fdfde..5f9bb2403 100644 --- a/mcp.mdx +++ b/mcp.mdx @@ -8,7 +8,7 @@ icon: 'audio-waveform' The Model Context Protocol (MCP) is an open protocol that connects your functions to LLMs and AI applications. With Mintlify's integration, you can automatically generate an MCP server from your existing documentation or OpenAPI specifications, enabling seamless AI-powered interactions with your product. -## Quick Usage Guide +## Quick usage guide Any public documentation hosted on Mintlify can be extracted as an MCP server using a simple command: @@ -36,7 +36,7 @@ These can be found in your [Mintlify Dashboard](https://dashboard.mintlify.com/s API Keys -### Select MCP Clients +### Select MCP clients After authentication, you'll choose which MCP clients to enable for your server: @@ -46,19 +46,19 @@ After authentication, you'll choose which MCP clients to enable for your server: Once configured, your MCP server is ready to use with the command provided in the terminal. -## Configuring Your MCP Server +## Configuring your MCP server Now let's take a look at how to configure your MCP server. -### Default Functionality +### Default functionality All MCP servers include the `search` tool by default, allowing users to query information across your entire documentation. -### Adding API Functions +### Adding API functions If you have an OpenAPI specification, you can expose specific endpoints as MCP tools by using the `x-mcp` extension at either the file or endpoint level. -#### File-Level Configuration +#### File-level configuration Enable MCP for all endpoints in a specification file: @@ -72,7 +72,7 @@ Enable MCP for all endpoints in a specification file: } ``` -#### Endpoint-Level Configuration +#### Endpoint-level configuration Enable MCP for specific endpoints only: @@ -89,11 +89,11 @@ Enable MCP for specific endpoints only: } ``` -### Authentication Handling +### Authentication handling If your OpenAPI spec defines authentication using securitySchemes, these authentication methods will be automatically applied to your MCP server. -### Monitoring Your MCP Server +### Monitoring your MCP server After publishing your changes, you can view all available MCP tools in the **Available Tools** section on the MCP server page in your dashboard. @@ -104,7 +104,7 @@ After publishing your changes, you can view all available MCP tools in the **Ava ## Distribution -### User Installation +### User installation Your users can install and use your MCP server with: @@ -112,4 +112,4 @@ Your users can install and use your MCP server with: npx mint-mcp add ``` -This provides them with a ready-to-use MCP server that connects your documented functions to AI applications. \ No newline at end of file +This provides them with a ready-to-use MCP server that connects your documented functions to AI applications. From c011c3be9a5ad6d87de1640963dddb3b348f7ba0 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 20 Jun 2025 11:11:24 -0700 Subject: [PATCH 2/3] copyedit page --- mcp.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/mcp.mdx b/mcp.mdx index 5f9bb2403..80cba6591 100644 --- a/mcp.mdx +++ b/mcp.mdx @@ -10,7 +10,7 @@ The Model Context Protocol (MCP) is an open protocol that connects your function ## Quick usage guide -Any public documentation hosted on Mintlify can be extracted as an MCP server using a simple command: +Any public documentation hosted on Mintlify can be extracted as an MCP server using the following command: ```bash npx mint-mcp add @@ -30,10 +30,10 @@ npx mint-mcp add mintlify.com When you run the command, you'll need to provide two API keys, `External Admin Key` and `Assistant API Key`. -These can be found in your [Mintlify Dashboard](https://dashboard.mintlify.com/settings/organization/api-keys) under **Settings > API Keys**. +These can be found in your [dashboard](https://dashboard.mintlify.com/settings/organization/api-keys) under **Settings > API Keys**. - API Keys + Terminal prompt asking What is the Bearer Token for Mintlify External API? ### Select MCP clients @@ -41,7 +41,7 @@ These can be found in your [Mintlify Dashboard](https://dashboard.mintlify.com/s After authentication, you'll choose which MCP clients to enable for your server: - MCP Clients + MCP Clients listed in the terminal. Once configured, your MCP server is ready to use with the command provided in the terminal. @@ -91,15 +91,15 @@ Enable MCP for specific endpoints only: ### Authentication handling -If your OpenAPI spec defines authentication using securitySchemes, these authentication methods will be automatically applied to your MCP server. +If your OpenAPI spec defines authentication using `securitySchemes`, these authentication methods will be automatically applied to your MCP server. ### Monitoring your MCP server After publishing your changes, you can view all available MCP tools in the **Available Tools** section on the MCP server page in your dashboard. - MCP Dashboard - + MCP dashboard with Available tools section emphasized + ## Distribution From 58662a0dabba05719c6a97141094bc96ae244995 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 20 Jun 2025 11:22:09 -0700 Subject: [PATCH 3/3] add note about auth restricting MCP server generation --- mcp.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/mcp.mdx b/mcp.mdx index 80cba6591..46ea0b04d 100644 --- a/mcp.mdx +++ b/mcp.mdx @@ -8,9 +8,13 @@ icon: 'audio-waveform' The Model Context Protocol (MCP) is an open protocol that connects your functions to LLMs and AI applications. With Mintlify's integration, you can automatically generate an MCP server from your existing documentation or OpenAPI specifications, enabling seamless AI-powered interactions with your product. -## Quick usage guide + + MCP servers can only be generated for public documentation. Documentation behind end-user authentication cannot be accessed for server generation. + -Any public documentation hosted on Mintlify can be extracted as an MCP server using the following command: +## Generating your MCP server + +Public documentation hosted on Mintlify can be extracted as an MCP server using the following command: ```bash npx mint-mcp add