Skip to content

Commit 2c9e918

Browse files
Documentation edits made through Mintlify web editor (#594)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 7724d2c commit 2c9e918

File tree

1 file changed

+55
-48
lines changed

1 file changed

+55
-48
lines changed

advanced/mcp/quickstart.mdx

Lines changed: 55 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Quickstart"
3-
description: "[MCP](https://modelcontextprotocol.io/introduction) simplifies how you provide tools to LLMs"
3+
description: "Generate an MCP server to help connect your product to LLMs"
44
---
55

66
## Introduction
@@ -11,6 +11,7 @@ Mintlify enables you to create an MCP server that allows AI tools to interact wi
1111

1212
1. **Docs Q&A**, similar to our AI Chat. This is automatically enabled for your docs, no setup required.
1313
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.
14+
1415
<Note>
1516
By enabling the OpenAPI toggle, you are allowing the MCP server to access
1617
**all** endpoints in your OpenAPI spec.
@@ -19,7 +20,7 @@ Mintlify enables you to create an MCP server that allows AI tools to interact wi
1920
## Install the MCP server
2021

2122
<Tip>
22-
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/generate) page.
23+
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/generate) page.
2324
</Tip>
2425

2526
## Example installation with the Mintlify MCP server
@@ -29,60 +30,66 @@ To use the Mintlify MCP server you will need an [API key](https://mintlify.com/d
2930
## Start the MCP server locally
3031

3132
<Steps>
32-
<Step title="Install the server through the CLI">
33-
Run the following command to install the server:
34-
```bash
35-
npx @mintlify/mcp add mintlify
36-
```
37-
</Step>
38-
<Step title="Add the authentication token">
39-
The following response will be given after running the previous command:
40-
```
41-
> What is the Authorization (basic token)?
42-
```
43-
Using your API chat key, copy the authentication token and paste it into the CLI.
44-
45-
</Step>
46-
<Step title="Start your MCP server">
47-
You can now run:
48-
```bash
49-
npm --prefix ~/.mcp/mintlify start
50-
```
51-
</Step>
33+
<Step title="Install the server through the CLI">
34+
Run the following command to install the server:
35+
36+
```bash
37+
npx @mintlify/mcp add mintlify
38+
```
39+
</Step>
40+
<Step title="Add the authentication token">
41+
The following response will be given after running the previous command:
42+
43+
```
44+
> What is the Authorization (basic token)?
45+
```
46+
47+
Using your API chat key, copy the authentication token and paste it into the CLI.
48+
</Step>
49+
<Step title="Start your MCP server">
50+
You can now run:
51+
52+
```bash
53+
npm --prefix ~/.mcp/mintlify start
54+
```
55+
</Step>
5256
</Steps>
5357

5458
## Use your server with Claude
5559

5660
<Note>
57-
Download the [Claude Desktop App](https://claude.ai/download)
61+
Download the [Claude Desktop App](https://claude.ai/download)
5862
</Note>
5963

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

6266
<Steps>
63-
<Step title="Navigate to the Settings > Developer" />
64-
<Step title="Click on Edit Config">
65-
Add the following to the `claude_desktop_config.json`:
66-
```json
67-
{
68-
"mcpServers": {
69-
"mintlify": {
70-
"command": "npm",
71-
"args": [
72-
"--prefix",
73-
"~/.mcp/mintlify",
74-
"start"
75-
]
76-
}
77-
}
78-
}
79-
```
80-
</Step>
81-
<Step title="If you see the hammer icon, you're all set!">
82-
If you click on it, you should see the available MCP Tools in your server.
83-
<Frame>
84-
<img src="/images/mcp-with-claude.png" alt="Claude MCP" />
85-
</Frame>
86-
</Step>
87-
</Steps>
67+
<Step title="Navigate to the Settings > Developer">
68+
69+
</Step>
70+
<Step title="Click on Edit Config">
71+
Add the following to the `claude_desktop_config.json`:
72+
73+
```json
74+
{
75+
"mcpServers": {
76+
"mintlify": {
77+
"command": "npm",
78+
"args": [
79+
"--prefix",
80+
"~/.mcp/mintlify",
81+
"start"
82+
]
83+
}
84+
}
85+
}
86+
```
87+
</Step>
88+
<Step title="If you see the hammer icon, you're all set!">
89+
If you click on it, you should see the available MCP Tools in your server.
8890

91+
<Frame>
92+
![Claude MCP](/images/mcp-with-claude.png)
93+
</Frame>
94+
</Step>
95+
</Steps>

0 commit comments

Comments
 (0)