Skip to content
Merged
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@
## Accessing your MCP server

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

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

In general, use active voice instead of passive voice ('be generated').

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

Use 'can't' instead of 'cannot'.

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

In general, use active voice instead of passive voice ('be accessed').
</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).

The `/mcp` path is reserved for hosted MCP servers and cannot be used for other navigation elements.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L26

In general, use active voice instead of passive voice ('is reserved').

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L26

Use 'can't' instead of 'cannot'.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L26

In general, use active voice instead of passive voice ('be used').

## Configuring your MCP server

All MCP servers include the `search` tool by default, allowing users to query information from your docs in other tools.
All MCP servers include the `search` tool by default, which allows users to query information from your docs in other tools.

If you have a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=mcp), you can expose endpoints from your OpenAPI specification as MCP tools.

To expose endpoints as MCP tools, use the `mcp` object within the `x-mint` extension at either the file or endpoint level. For example, the Mintlify MCP server includes tools to create assistant chats, get status updates, and trigger updates.

MCP servers follow a security-first approach where API endpoints are not exposed by default. You must explicitly enable endpoints to make them available as MCP tools. Only expose endpoints that are safe for public access through AI tools.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L36

Use 'aren't' instead of 'are not'.

<ResponseField name="mcp" type="object">
The MCP configuration for the endpoint.
Expand Down Expand Up @@ -63,7 +63,7 @@
"enabled": true
}
},
// ...

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L66

In general, don't use an ellipsis.
"paths": {
"/api/v1/users": {
"get": {
Expand All @@ -72,7 +72,7 @@
"enabled": false // Disables MCP for this endpoint
}
},
// ...

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L75

In general, don't use an ellipsis.
}
}
}
Expand Down Expand Up @@ -220,7 +220,7 @@

### Example: Connecting to the Mintlify MCP server

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.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L223

Try to avoid using first-person plural like 'our'.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L223

Avoid using 'will'.

<Tabs>
<Tab title="Contextual menu">
Expand All @@ -240,7 +240,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 243 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L243

Use parentheses judiciously.
2. Select the Mintlify MCP server.
3. Ask Claude a question about Mintlify.
</Step>
Expand Down Expand Up @@ -275,7 +275,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.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L278

Avoid using 'will'.
</Step>
<Step title="Configure the Mintlify MCP server">
In `mcp.json`, add:
Expand Down Expand Up @@ -329,8 +329,8 @@
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" class="block dark:hidden" />
<img src="/images/mcp/mcp-server-page-dark.png" alt="MCP dashboard with Available tools section emphasized" class="hidden dark:block" />
<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>

## Troubleshooting
Expand Down
Loading