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
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ 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
+
## Quick usage guide
12
12
13
13
Any public documentation hosted on Mintlify can be extracted as an MCP server using a simple command:
14
14
@@ -36,7 +36,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:
42
42
@@ -46,19 +46,19 @@ After authentication, you'll choose which MCP clients to enable for your server:
46
46
47
47
Once configured, your MCP server is ready to use with the command provided in the terminal.
48
48
49
-
## Configuring Your MCP Server
49
+
## Configuring your MCP server
50
50
51
51
Now let's take a look at how to configure your MCP server.
52
52
53
-
### Default Functionality
53
+
### Default functionality
54
54
55
55
All MCP servers include the `search` tool by default, allowing users to query information across your entire documentation.
56
56
57
-
### Adding API Functions
57
+
### Adding API functions
58
58
59
59
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
60
61
-
#### File-Level Configuration
61
+
#### File-level configuration
62
62
63
63
Enable MCP for all endpoints in a specification file:
64
64
@@ -72,7 +72,7 @@ Enable MCP for all endpoints in a specification file:
72
72
}
73
73
```
74
74
75
-
#### Endpoint-Level Configuration
75
+
#### Endpoint-level configuration
76
76
77
77
Enable MCP for specific endpoints only:
78
78
@@ -89,11 +89,11 @@ Enable MCP for specific endpoints only:
89
89
}
90
90
```
91
91
92
-
### Authentication Handling
92
+
### Authentication handling
93
93
94
94
If your OpenAPI spec defines authentication using securitySchemes, these authentication methods will be automatically applied to your MCP server.
95
95
96
-
### Monitoring Your MCP Server
96
+
### Monitoring your MCP server
97
97
98
98
After publishing your changes, you can view all available MCP tools in the **Available Tools** section on the MCP server page in your dashboard.
99
99
@@ -104,12 +104,12 @@ After publishing your changes, you can view all available MCP tools in the **Ava
104
104
105
105
## Distribution
106
106
107
-
### User Installation
107
+
### User installation
108
108
109
109
Your users can install and use your MCP server with:
110
110
111
111
```bash
112
112
npx mint-mcp add <your-subdomain-or-domain>
113
113
```
114
114
115
-
This provides them with a ready-to-use MCP server that connects your documented functions to AI applications.
115
+
This provides them with a ready-to-use MCP server that connects your documented functions to AI applications.
0 commit comments