Skip to content

Commit 9767299

Browse files
committed
Fixed docs
1 parent 773de6d commit 9767299

File tree

5 files changed

+48
-103
lines changed

5 files changed

+48
-103
lines changed

advanced/mcp/mcp-claude.mdx

Lines changed: 0 additions & 41 deletions
This file was deleted.

advanced/mcp/mcp-cli.mdx

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,66 @@
11
---
2-
title: "MCP CLI"
3-
description: "Learn how to use the MCP CLI"
2+
title: "Use Mintlify's MCP Server"
3+
description: "Learn how to use the Mintlify's MCP Server"
44
---
5+
<Tip>
6+
To get started with the MCP server make sure you have an API key. If you don't have one, navigate to `Settings > API Keys > Chat API Key` and create a new key.
7+
</Tip>
58

9+
## Start the MCP server locally
610
<Steps>
711
<Step title="Install the server through the CLI">
812
Run the following command to install the server:
913
```bash
10-
npx mcp add {subdomain}
14+
npx mcp add mintlify
1115
```
1216
</Step>
1317
<Step title="Add the authentication token">
1418
The following response will be given after running the previous command:
1519
```
1620
> What is the Authorization (basic token)?
1721
```
18-
<Tip>
19-
Grab your authentication token using the steps from the previous [section](/advanced/mcp/mcp-dashboard).
20-
</Tip>
21-
Copy the authentication token and paste it into the CLI.
22+
Using your API chat key, copy the authentication token and paste it into the CLI.
2223

2324
</Step>
2425
<Step title="Start your MCP server">
2526
You can now run:
2627
```bash
27-
npm --prefix ~/.mcp/{mcp-server-name} start
28+
npm --prefix ~/.mcp/mintlify start
2829
```
2930
</Step>
3031
</Steps>
32+
33+
## Use your server with Claude
34+
<Note>
35+
Download the the [Claude Desktop App](https://claude.ai/download)
36+
</Note>
37+
38+
Once you have the Claude Desktop App installed, follow these steps:
39+
40+
<Steps>
41+
<Step title="Navigate to the Settings > Developer" />
42+
<Step title="Click on Edit Config">
43+
Add the following to the `claude_desktop_config.json`:
44+
```json
45+
{
46+
"mcpServers": {
47+
"mintlify": {
48+
"command": "npm",
49+
"args": [
50+
"--prefix",
51+
"~/.mcp/mintlify",
52+
"start"
53+
]
54+
}
55+
}
56+
}
57+
```
58+
</Step>
59+
<Step title="If you see the hammer icon, you're all set!">
60+
If you click on it, you should see the available MCP Tools in your server.
61+
<Frame>
62+
<img src="/images/claude-mcp.png" alt="Claude MCP" />
63+
</Frame>
64+
</Step>
65+
</Steps>
66+

advanced/mcp/mcp-dashboard.mdx

Lines changed: 0 additions & 34 deletions
This file was deleted.

advanced/mcp/mcp-overview.mdx

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,8 @@ The MCP Server is a simple HTTP server that listens for MCP client requests and
1919

2020
Model Context Protocol is a standard released by Anthropic in November 2024 to simplify how applications can provide context to large language models (LLMs).
2121

22-
It enables LLMs to use external tools & services, with MCP servers exposing your data to AI and MCP clients allowing access to that data. For example, you can use an MCP client like Windsurf or Cursor to search for a pull request by using [GitHub’s MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/github).
22+
Mintlify enables you to set up an MCP server that allows AI tools to interact with your docs in these key scenarios:
2323

24-
While MCPs have recently gained intense traction as a way to embed products into AI ecosystems, best practices are still evolving.
25-
26-
We believe the most effective approach is to dynamically generate MCP servers based on existing data structures, like your OpenAPI spec. With a simple CLI installation, Mintlify enables you to do just that—automatically setting up an MCP server that allows AI tools to interact with your docs in these key scenarios:
27-
28-
1. **General information retrieval**, when users want to get a contextual answer
29-
2. **Real-time API querying**, when users want AI to execute actions on their behalf
30-
31-
## How do I get started?
32-
<CardGroup cols={2}>
33-
<Card title="Generate an MCP Server" href="/advanced/mcp/mcp-dashboard">
34-
Head to your dashboard and select the MCP Server tab under Products.
35-
</Card>
36-
<Card title="Deploy with our CLI" href="/advanced/mcp/mcp-cli">
37-
Use our NPM package to start an MCP server in minutes.
38-
</Card>
39-
</CardGroup>
24+
1. **Docs Q&A**, similar to our AI Chat. This is automatically enabled for your docs, no setup required.
25+
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.
4026

docs.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,7 @@
140140
"icon": "server",
141141
"pages": [
142142
"advanced/mcp/mcp-overview",
143-
"advanced/mcp/mcp-dashboard",
144-
"advanced/mcp/mcp-cli",
145-
"advanced/mcp/mcp-claude"
143+
"advanced/mcp/mcp-cli"
146144
]
147145
},
148146
{

0 commit comments

Comments
 (0)