Skip to content

removed link from MCP page #594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2025
Merged

removed link from MCP page #594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 55 additions & 48 deletions advanced/mcp/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Quickstart"
description: "[MCP](https://modelcontextprotocol.io/introduction) simplifies how you provide tools to LLMs"
description: "Generate an MCP server to help connect your product to LLMs"
---

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

1. **Docs Q&A**, similar to our AI Chat. This is automatically enabled for your docs, no setup required.
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.

<Note>
By enabling the OpenAPI toggle, you are allowing the MCP server to access
**all** endpoints in your OpenAPI spec.
Expand All @@ -19,7 +20,7 @@ Mintlify enables you to create an MCP server that allows AI tools to interact wi
## Install the MCP server

<Tip>
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.
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.
</Tip>

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

<Steps>
<Step title="Install the server through the CLI">
Run the following command to install the server:
```bash
npx @mintlify/mcp add mintlify
```
</Step>
<Step title="Add the authentication token">
The following response will be given after running the previous command:
```
> What is the Authorization (basic token)?
```
Using your API chat key, copy the authentication token and paste it into the CLI.

</Step>
<Step title="Start your MCP server">
You can now run:
```bash
npm --prefix ~/.mcp/mintlify start
```
</Step>
<Step title="Install the server through the CLI">
Run the following command to install the server:

```bash
npx @mintlify/mcp add mintlify
```
</Step>
<Step title="Add the authentication token">
The following response will be given after running the previous command:

```
> What is the Authorization (basic token)?
```

Using your API chat key, copy the authentication token and paste it into the CLI.
</Step>
<Step title="Start your MCP server">
You can now run:

```bash
npm --prefix ~/.mcp/mintlify start
```
</Step>
</Steps>

## Use your server with Claude

<Note>
Download the [Claude Desktop App](https://claude.ai/download)
Download the [Claude Desktop App](https://claude.ai/download)
</Note>

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

<Steps>
<Step title="Navigate to the Settings > Developer" />
<Step title="Click on Edit Config">
Add the following to the `claude_desktop_config.json`:
```json
{
"mcpServers": {
"mintlify": {
"command": "npm",
"args": [
"--prefix",
"~/.mcp/mintlify",
"start"
]
}
}
}
```
</Step>
<Step title="If you see the hammer icon, you're all set!">
If you click on it, you should see the available MCP Tools in your server.
<Frame>
<img src="/images/mcp-with-claude.png" alt="Claude MCP" />
</Frame>
</Step>
</Steps>
<Step title="Navigate to the Settings > Developer">

</Step>
<Step title="Click on Edit Config">
Add the following to the `claude_desktop_config.json`:

```json
{
"mcpServers": {
"mintlify": {
"command": "npm",
"args": [
"--prefix",
"~/.mcp/mintlify",
"start"
]
}
}
}
```
</Step>
<Step title="If you see the hammer icon, you're all set!">
If you click on it, you should see the available MCP Tools in your server.

<Frame>
![Claude MCP](/images/mcp-with-claude.png)
</Frame>
</Step>
</Steps>