Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 2.82 KB

quickstart.mdx

File metadata and controls

95 lines (73 loc) · 2.82 KB
title description
Quickstart
Generate an MCP server to help connect your product to AI apps

Introduction

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.

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.

    By enabling the OpenAPI toggle, you are allowing the MCP server to access **all** endpoints in your OpenAPI spec.

Install the MCP server

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.

Example installation with the Mintlify MCP server

To use the Mintlify MCP server you will need an API key from your Mintlify account. If you don't have one, navigate to Settings > API Keys > Chat API Key and create a new key.

Start the MCP server locally

Run the following command to install the server: 
```bash
npx @mintlify/mcp@latest add mintlify
```
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.
You can now run: 
```bash
npm --prefix ~/.mcp/mintlify start
```

Use your server with Claude

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

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

Add the following to the `claude_desktop_config.json`: 
```json
{
 "mcpServers": {
     "mintlify": {
         "command": "npm",
         "args": [
             "--prefix",
             "~/.mcp/mintlify",
             "start"
         ]
     }
 }
}
```
If you click on it, you should see the available MCP Tools in your server. 
<Frame>
  ![Claude MCP](/images/mcp-with-claude.png)
</Frame>