Skip to content

Commit 772e15a

Browse files
ethanpalmethanpalm
committed
update Mintlify example
1 parent 125c489 commit 772e15a

File tree

2 files changed

+63
-19
lines changed

2 files changed

+63
-19
lines changed

‎ai/contextual-menu.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The contextual menu includes several pre-built options that you can enable by ad
2222
| **Open in Perplexity** | `perplexity` | Creates a Perplexity conversation with the current page as context |
2323
| **Copy MCP server URL** | `mcp` | Copies your MCP server URL to the clipboard |
2424
| **Open in Cursor** | `cursor` | Installs your hosted MCP server in Cursor |
25-
| **Open in VSCode** | `vscode` | Installs your hosted MCP server in VSCode |
25+
| **Open in VS Code** | `vscode` | Installs your hosted MCP server in VS Code |
2626

2727
<Frame>
2828
<img

‎ai/model-context-protocol.mdx‎

Lines changed: 62 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ icon: "audio-waveform"
55
keywords: ["mcp"]
66
---
77

8+
import { PreviewButton } from "/snippets/previewbutton.jsx"
9+
810
## About MCP servers
911

1012
The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services, like documentation. Mintlify generates an MCP server from your documentation and OpenAPI specifications, preparing your content for the broader AI ecosystem where any MCP client (like Claude, Cursor, Goose, and others) can connect to your documentation and APIs.
@@ -122,7 +124,7 @@ These are some of the ways you can help your users connect to your MCP server:
122124
| :----- | :--------- | :---------- |
123125
| **Copy MCP server URL** | `mcp` | Copies your MCP server URL to the user's clipboard. |
124126
| **Open in Cursor** | `cursor` | Installs your MCP server in Cursor. |
125-
| **Open in VSCode** | `vscode` | Installs your MCP server in VSCode. |
127+
| **Open in VS Code** | `vscode` | Installs your MCP server in VS Code. |
126128
</Tab>
127129
<Tab title="Claude">
128130
<Steps>
@@ -186,13 +188,13 @@ See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-co
186188

187189
See the [Cursor documentation](https://docs.cursor.com/en/context/mcp#installing-mcp-servers) for more details.
188190
</Tab>
189-
<Tab title="VSCode">
191+
<Tab title="VS Code">
190192
<Steps>
191193
<Step title="Get your MCP server URL.">
192194
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
193195
</Step>
194196
<Step title="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.
197+
Create a guide for your users that includes your MCP server URL and the steps to connect it to VS Code.
196198

197199
1. Create a `.vscode/mcp.json` file.
198200
2. In `mcp.json`, configure your server:
@@ -210,7 +212,7 @@ See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-co
210212
</Step>
211213
</Steps>
212214

213-
See the [VSCode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more details.
215+
See the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more details.
214216
</Tab>
215217
</Tabs>
216218

@@ -219,57 +221,99 @@ See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-co
219221
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.
220222

221223
<Tabs>
224+
<Tab title="Contextual menu">
225+
At the top of this page, select the contextual menu and choose **Open in Cursor** or **Open in VS Code** to connect the Mintlify MCP server to the IDE of your choice.
226+
</Tab>
222227
<Tab title="Claude">
223228

224-
To use your MCP server with Claude:
229+
To use the Mintlify MCP server with Claude:
225230

226231
<Steps>
227-
<Step title="Add your MCP server to Claude">
232+
<Step title="Add the Mintlify MCP server to Claude">
228233
1. Navigate to the [Connectors](https://claude.ai/settings/connectors) page in the Claude settings.
229234
2. Select **Add custom connector**.
230-
3. Add your MCP server name and URL.
235+
3. Add the Mintlify MCP server:
236+
- Name: `Mintlify`
237+
- URL: `https://mintlify.com/docs/mcp`
231238
4. Select **Add**.
232239
</Step>
233-
<Step title="Access your MCP server in your chat">
234-
1. When using Claude, select the attachments button (the plus icon).
235-
2. Select your MCP server.
236-
3. Query Claude with your MCP server as context.
240+
<Step title="Access the MCP server in your chat">
241+
1. When using Claude, select the attachments button (the plus icon).
242+
2. Select the Mintlify MCP server.
243+
3. Ask Claude a question about Mintlify.
237244
</Step>
238245
</Steps>
239246

240247
See the [Model Context Protocol documentation](https://modelcontextprotocol.io/docs/tutorials/use-remote-mcp-server#connecting-to-a-remote-mcp-server) for more details.
241248

249+
</Tab>
250+
<Tab title="Claude Code">
251+
252+
To use the Mintlify MCP server with Claude Code, run the following command:
253+
254+
```bash
255+
claude mcp add --transport http Mintlify https://mintlify.com/docs/mcp
256+
```
257+
258+
Test the connection by running:
259+
260+
```bash
261+
claude mcp list
262+
```
263+
264+
See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-code/mcp#installing-mcp-servers) for more details.
242265
</Tab>
243266
<Tab title="Cursor">
244267

245-
To connect your MCP server to Cursor:
268+
<PreviewButton href="cursor://anysphere.cursor-deeplink/mcp/install?name=mintlify&config=eyJ1cmwiOiJodHRwczovL21pbnRsaWZ5LmNvbS9kb2NzL21jcCJ9">Install in Cursor.</PreviewButton>
269+
270+
To connect the Mintlify MCP server to Cursor, click the **Install in Cursor** button. Or to manually connect the MCP server, follow these steps:
246271

247272
<Steps>
248273
<Step title="Open MCP settings">
249274
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.
250275
2. Search for "Open MCP settings".
251276
3. Select **Add custom MCP**. This will open the `mcp.json` file.
252277
</Step>
253-
<Step title="Configure your server">
254-
In `mcp.json`, configure your server:
278+
<Step title="Configure the Mintlify MCP server">
279+
In `mcp.json`, add:
255280

256-
```json mcp.json example
281+
```json
257282
{
258283
"mcpServers": {
259-
"server-name": {
260-
"url": "https://your-docs-site.com/mcp"
284+
"Mintlify": {
285+
"url": "https://mintlify.com/docs/mcp"
261286
}
262287
}
263288
}
264289
```
265290
</Step>
266291
<Step title="Test the connection">
267-
In Cursor's chat, you can ask "What tools do you have available?" Cursor should have your documentation search and any configured API endpoints.
292+
In Cursor's chat, ask "What tools do you have available?" Cursor should show the Mintlify MCP server as an available tool.
268293
</Step>
269294
</Steps>
270295

271296
See [Installing MCP servers](https://docs.cursor.com/en/context/mcp#installing-mcp-servers) in the Cursor documentation for more details.
272297
</Tab>
298+
<Tab title="VS Code">
299+
300+
<PreviewButton href="https://vscode.dev/redirect/mcp/install?name=mintlify&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmintlify.com%2Fdocs%2Fmcp%22%7D">Install in VS Code.</PreviewButton>
301+
302+
To connect the Mintlify MCP server to VS Code, click the **Install in VS Code** button. Or to manually connect the MCP server, create a `.vscode/mcp.json` file and add:
303+
304+
```json
305+
{
306+
"servers": {
307+
"Mintlify": {
308+
"type": "http",
309+
"url": "https://mintlify.com/docs/mcp"
310+
}
311+
}
312+
}
313+
```
314+
315+
See the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more details.
316+
</Tab>
273317
</Tabs>
274318

275319
## Authentication

0 commit comments

Comments
 (0)