Skip to content
Merged
Show file tree
Hide file tree
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
69 changes: 69 additions & 0 deletions advanced/mcp/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: "The Mintlify MCP Server"
description: "Learn how to install and use the Mintlify's MCP Server"
---
<Tip>
This page is dedicated to the Mintlify MCP Server. If you are looking for information on generating your MCP, please refer to the [MCP Generator](/advanced/mcp/overview) page.
</Tip>

## Get started
To use the Mintlify MCP server you will need an [API key](https://mintlify.com/docs/advanced/rest-api/overview#authentication) from your Mintlify account. If you don't have one, navigate to `Settings > API Keys > Chat API Key` and create a new key.

## Start the MCP server locally
<Steps>
<Step title="Install the server through the CLI">
Run the following command to install the server:
```bash
npx mcp add mintlify

Check warning on line 17 in advanced/mcp/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/cli.mdx#L17

Did you really mean 'npx'?

Check warning on line 17 in advanced/mcp/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/cli.mdx#L17

Did you really mean 'mcp'?
```
</Step>
<Step title="Add the authentication token">
The following response will be given after running the previous command:
```
> What is the Authorization (basic token)?
```
Using your API chat key, copy the authentication token and paste it into the CLI.

</Step>
<Step title="Start your MCP server">
You can now run:
```bash
npm --prefix ~/.mcp/mintlify start
```
</Step>
</Steps>

## Use your server with Claude
<Note>
Download the the [Claude Desktop App](https://claude.ai/download)

Check warning on line 38 in advanced/mcp/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/cli.mdx#L38

'the' is repeated!
</Note>

Once you have the Claude Desktop App installed, follow these steps:

<Steps>
<Step title="Navigate to the Settings > Developer" />
<Step title="Click on Edit Config">
Add the following to the `claude_desktop_config.json`:
```json
{
"mcpServers": {

Check warning on line 49 in advanced/mcp/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/cli.mdx#L49

Did you really mean 'mcpServers'?
"mintlify": {
"command": "npm",
"args": [
"--prefix",
"~/.mcp/mintlify",
"start"
]
}
}
}
```
</Step>
<Step title="If you see the hammer icon, you're all set!">
If you click on it, you should see the available MCP Tools in your server.
<Frame>
<img src="/images/mcp-with-claude.png" alt="Claude MCP" />
</Frame>
</Step>
</Steps>

38 changes: 38 additions & 0 deletions advanced/mcp/generate.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Generate your MCP Server"
description: "Learn how to set up your own MCP Server"
---

<Tip>
This page is dedicated to setting up your own MCP Server. If you are looking
for information on using the Mintlify MCP Server, please refer to the
[Installing and using the Mintlify MCP Server](/advanced/mcp/cli) page.
</Tip>

## Get started

Run `npm i mcp` to install the `mcp` CLI.

In the [dashboard](https://dashboard.mintlify.com/products/mcp) go to `MCP Server`, on this page toggle to see your unique installation command. This is the command to install your MCP Server with the `mcp` CLI.

<Note>
Make sure to toggle OpenAPI access to allow the MCP server to access **all**
endpoints in your OpenAPI spec.
</Note>

## Start the MCP server locally

<Steps>
<Step title="Install the server through the CLI">
Run the following command to install the server: ```bash npx mcp add [your
subdomain] ```
</Step>
<Step title="Add the authentication token if applicable">
If your API requires an authentication token, tell your end-customer to get
it and apply it when given this response: ``` > What is the Authorization
(basic token)? ``` Otherwise, you can skip this step.
</Step>
<Step title="Start your MCP server">
You can now run: ```bash npm --prefix ~/.mcp/[your subdomain] start ```
</Step>
</Steps>
17 changes: 17 additions & 0 deletions advanced/mcp/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Overview"
description: "[MCP](https://modelcontextprotocol.io/introduction) simplifies how you provide tools to LLMs"
---

## MCP Generator

The MCP Generator is a CLI tool that generates an MCP server based on your company's documentation & OpenAPI specification if available. It takes in your documentation and a OpenAPI spec and outputs an MCP server that can be used with any MCP client. The MCP Generator is delivered via [npm package](https://www.npmjs.com/package/mcp) and generates an MCP server that can be used with any MCP client.

Mintlify enables you to create an MCP server that allows AI tools to interact with your docs in these key scenarios:

1. **Docs Q&A**, similar to our AI Chat. This is automatically enabled for your docs, no setup required.
2. **Real-time API querying**, if you have an OpenAPI spec, head to the `Mintlify Dashboard > Products > MCP Server` and hit the toggle to enable your OpenAPI spec.
<Note>
By enabling the OpenAPI toggle, you are allowing the MCP server to access
**all** endpoints in your OpenAPI spec.
</Note>
16 changes: 14 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,19 @@
{
"group": "Dashboard Access",
"icon": "house-lock",
"pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"]
"pages": [
"advanced/dashboard/sso",
"advanced/dashboard/permissions"
]
},
{
"group": "Model Context Protocol",
"icon": "server",
"pages": [
"advanced/mcp/overview",
"advanced/mcp/cli",
"advanced/mcp/generate"
]
},
{
"group": "REST API",
Expand Down Expand Up @@ -205,7 +217,7 @@
"pages": [
"integrations/analytics/overview",
"integrations/analytics/amplitude",
"integrations/analytics/clearbit",
"integrations/analytics/clearbit",
"integrations/analytics/fathom",
"integrations/analytics/google-analytics",
"integrations/analytics/google-tag-manager",
Expand Down
Binary file added images/claude-mcp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/mcp-auth-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/mcp-dash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/mcp-with-claude.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.