You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: mcp.mdx
+22-18Lines changed: 22 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,13 @@ icon: 'audio-waveform'
8
8
9
9
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.
10
10
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>
12
14
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:
14
18
15
19
```bash
16
20
npx mint-mcp add <your-subdomain-or-domain>
@@ -30,35 +34,35 @@ npx mint-mcp add mintlify.com
30
34
31
35
When you run the command, you'll need to provide two API keys, `External Admin Key` and `Assistant API Key`.
32
36
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**.
<imgsrc="/images/mcp/mcp-terminal-completed.png"alt="MCP Clients listed in the terminal." />
45
49
</Frame>
46
50
47
51
Once configured, your MCP server is ready to use with the command provided in the terminal.
48
52
49
-
## Configuring Your MCP Server
53
+
## Configuring your MCP server
50
54
51
55
Now let's take a look at how to configure your MCP server.
52
56
53
-
### Default Functionality
57
+
### Default functionality
54
58
55
59
All MCP servers include the `search` tool by default, allowing users to query information across your entire documentation.
56
60
57
-
### Adding API Functions
61
+
### Adding API functions
58
62
59
63
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.
60
64
61
-
#### File-Level Configuration
65
+
#### File-level configuration
62
66
63
67
Enable MCP for all endpoints in a specification file:
64
68
@@ -72,7 +76,7 @@ Enable MCP for all endpoints in a specification file:
72
76
}
73
77
```
74
78
75
-
#### Endpoint-Level Configuration
79
+
#### Endpoint-level configuration
76
80
77
81
Enable MCP for specific endpoints only:
78
82
@@ -89,27 +93,27 @@ Enable MCP for specific endpoints only:
89
93
}
90
94
```
91
95
92
-
### Authentication Handling
96
+
### Authentication handling
93
97
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.
95
99
96
-
### Monitoring Your MCP Server
100
+
### Monitoring your MCP server
97
101
98
102
After publishing your changes, you can view all available MCP tools in the **Available Tools** section on the MCP server page in your dashboard.
0 commit comments