Skip to content

Update MCP page #2387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 3 commits into from
Dec 17, 2025
Merged

Update MCP page #2387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7e418e
replace images
ethanpalm Dec 17, 2025
7a60518
move monitor info into access section
ethanpalm Dec 17, 2025
9087939
copyedits
ethanpalm Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 17 additions & 23 deletions ai/model-context-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,34 @@

### How MCP servers work

When an MCP server is connected to an AI tool, the LLM can decide to use your documentation search tool during response generation.
When an AI tool like Claude, Cursor, or ChatGPT has your documentation MCP server connected, the AI tool can search your documentation directly during response generation rather than doing a generic web search.

- The LLM can proactively search your documentation while generating a response, not just when explicitly asked.

Check warning on line 19 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L19 

Spell out 'LLM', if it's unfamiliar to the audience.
- The LLM determines when to use the search tool based on the context of the conversation and the relevance of your documentation.

Check warning on line 20 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L20 

Spell out 'LLM', if it's unfamiliar to the audience.
- Each tool call happens during the generation process, allowing the LLM to incorporate real-time information from your documentation into its response.

Check warning on line 21 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L21 

Spell out 'LLM', if it's unfamiliar to the audience.

For example, if a user asks a coding question and the LLM determines that your documentation is relevant, it can search your documentation and include that information in the response without the user explicitly asking about your documentation.

Check warning on line 23 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L23 

Spell out 'LLM', if it's unfamiliar to the audience.

## Accessing your MCP server
## Access your MCP server

<Note>
MCP servers can only be generated for public documentation. Documentation behind end-user authentication cannot be accessed for server generation.
MCP servers are only available for public documentation. Documentation behind end-user authentication cannot generate an MCP server.

Check warning on line 28 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L28 

Use 'can't' instead of 'cannot'.
</Note>

Mintlify automatically generates an MCP server for your documentation and hosts it at your documentation URL with the `/mcp` path. For example, Mintlify's MCP server is available at `https://mintlify.com/docs/mcp`.

You can see and copy your MCP server URL in your [dashboard](https://dashboard.mintlify.com/products/mcp).
View and copy your MCP server URL on the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.

The `/mcp` path is reserved for hosted MCP servers and cannot be used for other navigation elements.
<Frame>
<img src="/images/mcp/mcp-server-page-light.png" alt="MCP server page in the dashboard." className="block dark:hidden" />
<img src="/images/mcp/mcp-server-page-dark.png" alt="MCP server page in the dashboard." className="hidden dark:block" />
</Frame>

## Using your MCP server
<Note>
Hosted MCP servers use the `/mcp` path in their URLs. Other navigation elements cannot use the `/mcp` path.

Check warning on line 41 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L41 

Use 'can't' instead of 'cannot'.
</Note>

## Use your MCP server

Your users must connect your MCP server to their preferred AI tools.

Expand Down Expand Up @@ -99,7 +106,7 @@

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.
2. Search for "Open MCP settings".
3. Select **Add custom MCP**. This will open the `mcp.json` file.
3. Select **Add custom MCP**. This opens the `mcp.json` file.
4. In `mcp.json`, configure your server:

```json
Expand Down Expand Up @@ -144,9 +151,9 @@
</Tab>
</Tabs>

### Example: Connecting to the Mintlify MCP server
### Example: Connect to the Mintlify MCP server

Connect to the Mintlify MCP server to 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.
Connect to the Mintlify MCP server to search this documentation site within your preferred AI tool. This gives 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.

<Tabs>
<Tab title="Contextual menu">
Expand All @@ -166,7 +173,7 @@
4. Select **Add**.
</Step>
<Step title="Access the MCP server in your chat">
1. When using Claude, select the attachments button (the plus icon).

Check warning on line 176 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L176 

Use parentheses judiciously.
2. Select the Mintlify MCP server.
3. Ask Claude a question about Mintlify.
</Step>
Expand Down Expand Up @@ -201,7 +208,7 @@
<Step title="Open MCP settings">
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.
2. Search for "Open MCP settings".
3. Select **Add custom MCP**. This will open the `mcp.json` file.
3. Select **Add custom MCP**. This opens the `mcp.json` file.
</Step>
<Step title="Configure the Mintlify MCP server">
In `mcp.json`, add:
Expand Down Expand Up @@ -243,16 +250,3 @@
See the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more details.
</Tab>
</Tabs>



## Monitoring your MCP server

You can view all available MCP tools in the **Available tools** section of the [MCP Server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.

<Frame>
<img src="/images/mcp/mcp-server-page-light.png" alt="MCP dashboard with Available tools section emphasized" className="block dark:hidden" />
<img src="/images/mcp/mcp-server-page-dark.png" alt="MCP dashboard with Available tools section emphasized" className="hidden dark:block" />
</Frame>


Binary file modified images/mcp/mcp-server-page-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/mcp/mcp-server-page-light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.