Skip to content

Commit 8b7da6b

Browse files
committed
Update MCP docs
1 parent ba59280 commit 8b7da6b

File tree

3 files changed

+23
-22
lines changed

3 files changed

+23
-22
lines changed

advanced/mcp/overview.mdx

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

advanced/mcp/cli.mdx renamed to advanced/mcp/quickstart.mdx

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
11
---
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"
44
---
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+
521
<Tip>
622
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.
723
</Tip>
824

9-
## Get started
25+
## Example installation with the Mintlify MCP server
26+
1027
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.
1128

1229
## Start the MCP server locally
30+
1331
<Steps>
1432
<Step title="Install the server through the CLI">
1533
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
3452
</Steps>
3553

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

docs.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,7 @@
142142
"group": "Model Context Protocol",
143143
"icon": "server",
144144
"pages": [
145-
"advanced/mcp/overview",
146-
"advanced/mcp/cli",
145+
"advanced/mcp/quickstart",
147146
"advanced/mcp/generate"
148147
]
149148
},

0 commit comments

Comments
 (0)