You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: advanced/mcp/quickstart.mdx
+22-3Lines changed: 22 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,33 @@
1
1
---
2
-
title: "The Mintlify MCP Server"
3
-
description: "Learn how to install and use the Mintlify MCP Server"
2
+
title: "Quickstart"
3
+
description: "[MCP](https://modelcontextprotocol.io/introduction) simplifies how you provide tools to LLMs"
4
4
---
5
+
6
+
## Introduction
7
+
8
+
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.
9
+
10
+
Mintlify enables you to create an MCP server that allows AI tools to interact with your docs in these key scenarios:
11
+
12
+
1.**Docs Q&A**, similar to our AI Chat. This is automatically enabled for your docs, no setup required.
13
+
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
+
<Note>
15
+
By enabling the OpenAPI toggle, you are allowing the MCP server to access
16
+
**all** endpoints in your OpenAPI spec.
17
+
</Note>
18
+
19
+
## Install the MCP server
20
+
5
21
<Tip>
6
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/overview) page.
7
23
</Tip>
8
24
9
-
## Get started
25
+
## Example installation with the Mintlify MCP server
26
+
10
27
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.
11
28
12
29
## Start the MCP server locally
30
+
13
31
<Steps>
14
32
<Steptitle="Install the server through the CLI">
15
33
Run the following command to install the server:
@@ -34,6 +52,7 @@ To use the Mintlify MCP server you will need an [API key](https://mintlify.com/d
34
52
</Steps>
35
53
36
54
## Use your server with Claude
55
+
37
56
<Note>
38
57
Download the the [Claude Desktop App](https://claude.ai/download)
0 commit comments