Skip to content
Open
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
12 changes: 12 additions & 0 deletions ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| :-- | :-- | :-- |
| **Audience** | Your end users | Your team |
| **Access** | Read and search published pages | Read, edit, restructure, save |
| **Endpoint** | `/mcp` on your site domain | Hosted by Mintlify, scoped to your project |

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L23

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

## Connect to the Mintlify MCP
Expand Down Expand Up @@ -99,6 +99,18 @@
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>

## See which agent is editing

When an AI tool edits a page through the Mintlify MCP, the dashboard editor's live collaboration view shows the agent by name and icon, alongside the team member who authorized the connection. Open the `editorUrl` returned by `checkout` to watch edits stream in with the agent's avatar attached to the cursor and selection.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L104

Use 'Cursor' instead of 'cursor'.

The agent shown in the editor is detected from the MCP client's name during the OAuth handshake. Recognized clients include Claude, Claude Code, Cursor, ChatGPT, Codex, GitHub Copilot, Gemini, Windsurf, Cline, Roo Code, Goose, v0, Replit, and others. Unrecognized clients fall back to the client name reported by the OAuth client, with a generic AI agent icon.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L106

In general, use active voice instead of passive voice ('is detected').

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L106

Did you really mean 'Replit'?

Each edit also tracks the **authorizing user**—the team member who completed the OAuth login from the AI tool. This makes it easy to tell at a glance whose Claude Code or Cursor session triggered a given change when multiple teammates are working in parallel.

<Note>
Agent identification works for `edit_page`, `write_page`, and `create_node` calls. The editor avatar appears in real time as the agent streams edits, and the agent name persists in the session's awareness state until the connection closes.
</Note>

## What the Mintlify MCP can do

### Content
Expand Down Expand Up @@ -134,8 +146,8 @@
After you connect the Mintlify 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 149 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L149

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 150 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L150

Use 'REST' instead of 'rest'.

## Best practices

Expand Down
Loading