Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 25 additions & 24 deletions ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
@@ -1,50 +1,51 @@
---
title: "Mintlify MCP"
description: "Let AI tools directly edit your content on Mintlify with the MCP server. Connect Claude, Cursor, or any MCP client to draft, save, and ship doc changes."
title: "Admin Model Context Protocol (MCP) server"
shortTitle: "Admin MCP"
description: "Let AI tools directly edit your content and update settings in your dashboard with the admin MCP server. Connect Claude, Cursor, or any MCP client to draft, save, and ship changes."
keywords: ["MCP", "write access", "AI", "editing", "Claude", "Cursor", "branch", "pull request"]
---

## About the Mintlify MCP
## About the admin MCP

The Mintlify MCP server gives AI tools write access to your Mintlify content. Where the [documentation MCP server](/ai/model-context-protocol) lets AI tools read and search your published content, the Mintlify MCP lets them propose changes: edit pages, restructure navigation, update `docs.json`, and open pull requests.
The admin MCP server gives AI tools write access to your Mintlify content and settings. Use it to update content and access your dashboard. With the admin MCP, you can use your preferred AI tools to edit pages, restructure navigation, update `docs.json`, open pull requests, change settings, create workflows, and more.

Connect any MCP client like Claude, Claude Code, or Cursor to the Mintlify MCP to collaborate on your Mintlify content with the same tools you use to write code. When you use the MCP server, all changes happen on a branch and require a pull request to merge.
Connect any MCP client like Claude, Claude Code, or Cursor to the admin MCP server to collaborate on your Mintlify content and settings with the same tools you use to write code. When you use the admin MCP server, all changes happen on a branch and require a pull request to merge.

<Note>
The Mintlify MCP edits your documentation. Treat it like a developer with commit access. Connect it only from trusted AI tools and review every pull request before merging.
The admin MCP server allows AI tools to access your Mintlify dashboard. Treat it like a coworker with write access. Connect it only from trusted AI tools and review every pull request before merging.
</Note>

### How the Mintlify MCP differs from the documentation MCP
### How the admin MCP differs from the search MCP

| | Documentation MCP | Mintlify MCP |
| | Admin MCP | Search MCP |
| :-- | :-- | :-- |
| **Audience** | Your end users | Your team |
| **Access** | Read and search published pages | Read, edit, restructure, save |
| **Endpoints** | `/mcp` on your site domain | Hosted by Mintlify, scoped to your project |
| **Output** | Search results and page content | Content edits, navigation changes, pull requests |
| **Audience** | Your team | Your end users |
| **Access** | Read, edit, restructure, save, create workflows, manage settings | Read and search published pages |
| **Endpoints** | Hosted by Mintlify, scoped to your project | `/mcp` on your site domain |

Check warning on line 24 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L24

Use 'endpoints?' instead of 'Endpoints'.
| **Output** | Content edits, navigation changes, pull requests, workflow runs | Search results and page content |

## Connect to the Mintlify MCP
## Connect to the admin MCP

Connecting requires an interactive OAuth login against your Mintlify account. The AI tool exchanges that login for a session token scoped to one project.
You must have an interactive OAuth login against your Mintlify account to connect to the admin MCP. AI tools exchange that login for a session token scoped to one project.

<Tabs>
<Tab title="Claude">
<Steps>
<Step title="Add the Mintlify MCP as a custom connector">
<Step title="Add the admin MCP as a custom connector">
1. Navigate to the [Connectors](https://claude.ai/settings/connectors) page in the Claude settings.
2. Click **Add custom connector**.
3. Add the connector
- Name: Mintlify MCP
- URL:  `https://mcp.mintlify.com`
- Name: Admin MCP
- URL: `https://mcp.mintlify.com`
4. Click **Add** and complete the OAuth login.
</Step>
<Step title="Use the MCP in a chat">
Click the attachments button (the plus icon), then select your Mintlify MCP server. Claude can now call the Mintlify MCP tools while answering your prompt.
Click the attachments button (the plus icon), then select your admin MCP server. Claude can now call the Mintlify admin MCP tools while answering your prompt.
</Step>
</Steps>
</Tab>
<Tab title="Claude Code">
Add the Mintlify MCP server with the Claude Code CLI:
Add the admin MCP server with the Claude Code CLI:

```bash
claude mcp add --transport http mintlify https://mcp.mintlify.com
Expand All @@ -55,7 +56,7 @@
<Tab title="Cursor">
1. Open the command palette with <kbd>Command</kbd> \+ <kbd>Shift</kbd> \+ <kbd>P</kbd> (<kbd>Ctrl</kbd> \+ <kbd>Shift</kbd> \+ <kbd>P</kbd> on Windows).
2. Search for **Open MCP settings** and click **Add custom MCP**.
3. In `mcp.json`, add the Mintlify MCP:
3. In `mcp.json`, add the admin MCP:

```json
{
Expand All @@ -73,7 +74,7 @@

## How a session works

Every Mintlify MCP session binds to a single Git branch. The flow is:
Every admin MCP session binds to a single Git branch. The flow is:

<Steps>
<Step title="Check out a branch">
Expand All @@ -99,7 +100,7 @@
Calling `checkout` again during an active session switches the session to the new branch. Use this to abandon an in-progress draft and start fresh without ending the conversation.
</Tip>

## What the Mintlify MCP can do
## What the admin MCP can do

### Content

Expand All @@ -110,7 +111,7 @@

### Navigation

- **`list_nodes`** — Walk the navigation tree with optional filters. Filter by `parentId` (use `recursive: true` to include all descendants), one or more node types, or any division scope: `language`, `version`, `tab`, `dropdown`, `anchor`, `product`, or `item`. Results are paginated through an opaque `cursor`.

Check warning on line 114 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L114

In general, use active voice instead of passive voice ('are paginated').
- **`create_node`** — Add a new page, group, tab, anchor, version, language, product, or dropdown.
- **`update_node`** — Update a node's properties in place (rename a group, change an icon, set a default version).
- **`move_node`** — Move a node, including renaming a page's path.
Expand All @@ -131,11 +132,11 @@

## Example prompts

After you connect the Mintlify MCP, you can drive it with natural-language prompts. For example:
After you connect the admin MCP, you can drive it with natural-language prompts. For example:

- _"Check out a branch called `add-billing-faq` and create a new page under the FAQ group titled 'Billing'. Draft answers for the five questions in this Linear issue."_
- _"Find every page that mentions the deprecated `legacy_token` field and update the example to use `api_key` instead. Save as a PR titled 'docs: replace legacy\_token references'."_

Check warning on line 138 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L138

Did you really mean 'legacy_token'?
- _"Reorganize the API reference: move the webhooks pages into a new group called 'Webhooks' and update the icons to match the rest of the section."_

Check warning on line 139 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L139

Use 'REST' instead of 'rest'.

## Best practices

Expand All @@ -145,7 +146,7 @@
</Accordion>

<Accordion title="Review every PR">
The Mintlify MCP is powerful enough to rewrite hundreds of pages in a single session. Before merging, read the PR diff and skim the rendered preview. Don't rubber-stamp large changes.
The admin MCP is powerful enough to rewrite hundreds of pages in a single session. Before merging, read the PR diff and skim the rendered preview. Don't rubber-stamp large changes.
</Accordion>

<Accordion title="Use slugs for branch names">
Expand Down
Loading
Loading