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: ai/model-context-protocol.mdx
+110-4Lines changed: 110 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ Your MCP server exposes tools for AI applications to search your documentation a
17
17
MCP servers can only be generated for public documentation. Documentation behind end-user authentication cannot be accessed for server generation.
18
18
</Note>
19
19
20
-
Your MCP server is automatically generated and hosted at your documentation URL with the `/mcp` path.
20
+
Your MCP server is automatically generated and hosted at your documentation URL with the `/mcp` path. For example, Mintlify's MCP server is available at `https://mintlify.com/docs/mcp`.
21
21
22
-
For example, Mintlify's MCP server is available at `https://mintlify.com/docs/mcp`.
22
+
You can see and copy your MCP server URL in your [dashboard](https://dashboard.mintlify.com/products/mcp).
23
23
24
24
## Configuring your MCP server
25
25
@@ -106,11 +106,117 @@ Enable MCP for specific endpoints:
106
106
107
107
## Using your MCP server
108
108
109
-
Your users must connect your MCP server to their preferred AI tools.
109
+
Your users must connect your MCP server to their preferred AI tools.
110
110
111
111
1. Make your MCP server URL publicly available.
112
112
2. Users copy your MCP server URL and add it to their tools.
113
-
3. The tools will have standardized access to your documentation and API endpoints.
113
+
3. Users access your documentation and API endpoints through their tools.
114
+
115
+
These are some of the ways you can help your users connect to your MCP server:
116
+
117
+
<Tabs>
118
+
<Tabtitle="Contextual menu">
119
+
Add options in the [contextual menu](/ai/contextual-menu) for your users to connect to your MCP server from any page of your documentation.
120
+
121
+
| Option | Identifier | Description |
122
+
| :----- | :--------- | :---------- |
123
+
|**Copy MCP server URL**|`mcp`| Copies your MCP server URL to the user's clipboard. |
124
+
|**Open in Cursor**|`cursor`| Installs your MCP server in Cursor. |
125
+
|**Open in VSCode**|`vscode`| Installs your MCP server in VSCode. |
126
+
</Tab>
127
+
<Tabtitle="Claude">
128
+
<Steps>
129
+
<Steptitle="Get your MCP server URL.">
130
+
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
131
+
</Step>
132
+
<Steptitle="Publish your MCP server URL for your users.">
133
+
Create a guide for your users that includes your MCP server URL and the steps to connect it to Claude.
134
+
135
+
1. Navigate to the [Connectors](https://claude.ai/settings/connectors) page in the Claude settings.
136
+
2. Select **Add custom connector**.
137
+
3. Add your MCP server name and URL.
138
+
4. Select **Add**.
139
+
5. When using Claude, select the attachments button (the plus icon).
140
+
6. Select your MCP server.
141
+
</Step>
142
+
</Steps>
143
+
144
+
See the [Model Context Protocol documentation](https://modelcontextprotocol.io/docs/tutorials/use-remote-mcp-server#connecting-to-a-remote-mcp-server) for more details.
145
+
</Tab>
146
+
<Tabtitle="Claude Code">
147
+
<Steps>
148
+
<Steptitle="Get your MCP server URL.">
149
+
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
150
+
</Step>
151
+
<Steptitle="Publish your MCP server URL for your users.">
152
+
Create a guide for your users that includes your MCP server URL and the command to connect it to Claude Code.
153
+
154
+
```bash
155
+
claude mcp add --transport http <name> <url>
156
+
```
157
+
</Step>
158
+
</Steps>
159
+
160
+
See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-code/mcp#installing-mcp-servers) for more details.
161
+
</Tab>
162
+
<Tabtitle="Cursor">
163
+
<Steps>
164
+
<Steptitle="Get your MCP server URL.">
165
+
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
166
+
</Step>
167
+
<Steptitle="Publish your MCP server URL for your users.">
168
+
Create a guide for your users that includes your MCP server URL and the steps to connect it to Cursor.
169
+
170
+
1. Use <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows) to open the command palette.
171
+
2. Search for "Open MCP settings".
172
+
3. Select **Add custom MCP**. This will open the `mcp.json` file.
173
+
4. In `mcp.json`, configure your server:
174
+
175
+
```json
176
+
{
177
+
"mcpServers": {
178
+
"server-name": {
179
+
"url": "<your-mcp-server-url>"
180
+
}
181
+
}
182
+
}
183
+
```
184
+
</Step>
185
+
</Steps>
186
+
187
+
See the [Cursor documentation](https://docs.cursor.com/en/context/mcp#installing-mcp-servers) for more details.
188
+
</Tab>
189
+
<Tabtitle="VSCode">
190
+
<Steps>
191
+
<Steptitle="Get your MCP server URL.">
192
+
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
193
+
</Step>
194
+
<Steptitle="Publish your MCP server URL for your users.">
195
+
Create a guide for your users that includes your MCP server URL and the steps to connect it to VSCode.
196
+
197
+
1. Create a `.vscode/mcp.json` file.
198
+
2. In `mcp.json`, configure your server:
199
+
200
+
```json
201
+
{
202
+
"servers": {
203
+
"<server-name>": {
204
+
"type": "http",
205
+
"url": "<your-mcp-server-url>"
206
+
}
207
+
}
208
+
}
209
+
```
210
+
</Step>
211
+
</Steps>
212
+
213
+
See the [VSCode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more details.
214
+
</Tab>
215
+
</Tabs>
216
+
217
+
### Example: Connecting to the Mintlify MCP server
218
+
219
+
Connect to the Mintlify MCP server to interact with the Mintlify API and search our documentation. This will give you more accurate answers about how to use Mintlify in your local environment and demonstrates how you can help your users connect to your MCP server.
0 commit comments