Skip to content

updated mcp docs #625

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
Apr 10, 2025
Merged

updated mcp docs #625

Show file tree
Hide file tree
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
18 changes: 8 additions & 10 deletions advanced/mcp/generate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
---
title: "MCP Generator"
description: "Learn how to set up your own MCP Server"
description: "Learn how to set up an MCP Server for your docs"
---

<Tip>
This page is dedicated to setting up your own MCP Server. If you are looking
for information on using the Mintlify MCP Server, please refer to the
[Installing and using the Mintlify MCP Server](/advanced/mcp/quickstart) page.
This page to learn how to set up an MCP Server for your own documentation. If you are looking for information on using the Mintlify MCP Server, please refer to the [Installing and using the Mintlify MCP Server](/advanced/mcp/quickstart) page.
</Tip>

## Get started

Run `npm i @mintlify/mcp` to install the `@mintlify/mcp` CLI.

In the [dashboard](https://dashboard.mintlify.com/products/mcp) go to `MCP Server`, on this page toggle to see your unique installation command. This is the command to install your MCP Server with the `@mintlify/mcp` CLI.
In the [dashboard](https://dashboard.mintlify.com/products/mcp), navigate to `MCP Server`to see your unique installation command. This is the command to install your MCP Server with the `@mintlify/mcp` CLI.

Check warning on line 14 in advanced/mcp/generate.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/mcp/generate.mdx#L14 

'to' is repeated!

<Note>
Make sure to toggle OpenAPI access to allow the MCP server to access **all**
Expand All @@ -25,17 +23,17 @@
<Steps>
<Step title="Install the server through the CLI">
Run the following command to install the server:

```bash
npx @mintlify/mcp add [your subdomain]
```
</Step>
<Step title="Add the authentication token if applicable">
If your API requires an authentication token, tell your end-customer to get
it and apply it when given this response: ``` > What is the Authorization
(basic token)? ``` Otherwise, you can skip this step.
it and apply it when given this response: `> What is the Authorization
(basic token)?` Otherwise, you can skip this step.
</Step>
<Step title="Start your MCP server">
You can now run: ```bash npm --prefix ~/.mcp/[your subdomain] start ```
You can now run: `bash npm --prefix ~/.mcp/[your subdomain] start `
</Step>
</Steps>
</Steps>
10 changes: 5 additions & 5 deletions advanced/mcp/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Quickstart"
description: "Generate an MCP server to help connect your product to LLMs"
description: "Generate an MCP server to help connect your product to AI apps"
---

## Introduction

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.
Mintlify's MCP Generator is a CLI tool that generates an MCP server based on your company's documentation & OpenAPI specification (if available). The MCP Generator is delivered via [npm package](https://www.npmjs.com/package/mcp).

Mintlify enables you to create an MCP server that allows AI tools to interact with your docs in these key scenarios:
Your MCP server can then be used with any MCP client for these key scenarios:

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.
Expand All @@ -20,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 installing the Mintlify MCP Server. If you are looking for information on generating your own MCP server, please refer to the [MCP Generator](/advanced/mcp/generate) page.
</Tip>

## Example installation with the Mintlify MCP server
Expand All @@ -34,7 +34,7 @@ To use the Mintlify MCP server you will need an [API key](https://mintlify.com/d
Run the following command to install the server:

```bash
npx @mintlify/mcp add mintlify
npx @mintlify/mcp@latest add mintlify
```
</Step>
<Step title="Add the authentication token">
Expand Down