|
1 | 1 | --- |
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" |
4 | 4 | --- |
| 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> |
5 | 8 |
|
| 9 | +## Start the MCP server locally |
6 | 10 | <Steps> |
7 | 11 | <Step title="Install the server through the CLI"> |
8 | 12 | Run the following command to install the server: |
9 | 13 | ```bash |
10 | | - npx mcp add {subdomain} |
| 14 | + npx mcp add mintlify |
11 | 15 | ``` |
12 | 16 | </Step> |
13 | 17 | <Step title="Add the authentication token"> |
14 | 18 | The following response will be given after running the previous command: |
15 | 19 | ``` |
16 | 20 | > What is the Authorization (basic token)? |
17 | 21 | ``` |
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. |
22 | 23 |
|
23 | 24 | </Step> |
24 | 25 | <Step title="Start your MCP server"> |
25 | 26 | You can now run: |
26 | 27 | ```bash |
27 | | - npm --prefix ~/.mcp/{mcp-server-name} start |
| 28 | + npm --prefix ~/.mcp/mintlify start |
28 | 29 | ``` |
29 | 30 | </Step> |
30 | 31 | </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 | + |
0 commit comments