Skip to content

Commit 4fcc4e7

Browse files
authored
Clarify that auth restricts MCP server generation (#837)
* sentence case headers * copyedit page * add note about auth restricting MCP server generation
1 parent cf2a8de commit 4fcc4e7

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

mcp.mdx

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,13 @@ icon: 'audio-waveform'
88

99
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.
1010

11-
## Quick Usage Guide
11+
<Note>
12+
MCP servers can only be generated for public documentation. Documentation behind end-user authentication cannot be accessed for server generation.
13+
</Note>
1214

13-
Any public documentation hosted on Mintlify can be extracted as an MCP server using a simple command:
15+
## Generating your MCP server
16+
17+
Public documentation hosted on Mintlify can be extracted as an MCP server using the following command:
1418

1519
```bash
1620
npx mint-mcp add <your-subdomain-or-domain>
@@ -30,35 +34,35 @@ npx mint-mcp add mintlify.com
3034

3135
When you run the command, you'll need to provide two API keys, `External Admin Key` and `Assistant API Key`.
3236

33-
These can be found in your [Mintlify Dashboard](https://dashboard.mintlify.com/settings/organization/api-keys) under **Settings > API Keys**.
37+
These can be found in your [dashboard](https://dashboard.mintlify.com/settings/organization/api-keys) under **Settings > API Keys**.
3438

3539
<Frame>
36-
<img src="/images/mcp/mcp-terminal.png" alt="API Keys" />
40+
<img src="/images/mcp/mcp-terminal.png" alt="Terminal prompt asking What is the Bearer Token for Mintlify External API?" />
3741
</Frame>
3842

39-
### Select MCP Clients
43+
### Select MCP clients
4044

4145
After authentication, you'll choose which MCP clients to enable for your server:
4246

4347
<Frame>
44-
<img src="/images/mcp/mcp-terminal-completed.png" alt="MCP Clients" />
48+
<img src="/images/mcp/mcp-terminal-completed.png" alt="MCP Clients listed in the terminal." />
4549
</Frame>
4650

4751
Once configured, your MCP server is ready to use with the command provided in the terminal.
4852

49-
## Configuring Your MCP Server
53+
## Configuring your MCP server
5054

5155
Now let's take a look at how to configure your MCP server.
5256

53-
### Default Functionality
57+
### Default functionality
5458

5559
All MCP servers include the `search` tool by default, allowing users to query information across your entire documentation.
5660

57-
### Adding API Functions
61+
### Adding API functions
5862

5963
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.
6064

61-
#### File-Level Configuration
65+
#### File-level configuration
6266

6367
Enable MCP for all endpoints in a specification file:
6468

@@ -72,7 +76,7 @@ Enable MCP for all endpoints in a specification file:
7276
}
7377
```
7478

75-
#### Endpoint-Level Configuration
79+
#### Endpoint-level configuration
7680

7781
Enable MCP for specific endpoints only:
7882

@@ -89,27 +93,27 @@ Enable MCP for specific endpoints only:
8993
}
9094
```
9195

92-
### Authentication Handling
96+
### Authentication handling
9397

94-
If your OpenAPI spec defines authentication using securitySchemes, these authentication methods will be automatically applied to your MCP server.
98+
If your OpenAPI spec defines authentication using `securitySchemes`, these authentication methods will be automatically applied to your MCP server.
9599

96-
### Monitoring Your MCP Server
100+
### Monitoring your MCP server
97101

98102
After publishing your changes, you can view all available MCP tools in the **Available Tools** section on the MCP server page in your dashboard.
99103

100104
<Frame>
101-
<img src="/images/mcp/mcp-server-page-light.png" alt="MCP Dashboard" class="block dark:hidden" />
102-
<img src="/images/mcp/mcp-server-page-dark.png" alt="MCP Dashboard" class="hidden dark:block" />
105+
<img src="/images/mcp/mcp-server-page-light.png" alt="MCP dashboard with Available tools section emphasized" class="block dark:hidden" />
106+
<img src="/images/mcp/mcp-server-page-dark.png" alt="MCP dashboard with Available tools section emphasized" class="hidden dark:block" />
103107
</Frame>
104108

105109
## Distribution
106110

107-
### User Installation
111+
### User installation
108112

109113
Your users can install and use your MCP server with:
110114

111115
```bash
112116
npx mint-mcp add <your-subdomain-or-domain>
113117
```
114118

115-
This provides them with a ready-to-use MCP server that connects your documented functions to AI applications.
119+
This provides them with a ready-to-use MCP server that connects your documented functions to AI applications.

0 commit comments

Comments
 (0)