Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify-admin-mcp-admin-mcp-docs-b9cfd78.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

About the Mintlify MCP

The Mintlify MCP server gives AI tools write access to your Mintlify content. Where the documentation MCP server 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. 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.
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.

How the Mintlify MCP differs from the documentation MCP

Documentation MCPMintlify MCP
AudienceYour end usersYour team
AccessRead and search published pagesRead, edit, restructure, save
Endpoint/mcp on your site domainHosted by Mintlify, scoped to your project
OutputSearch results and page contentContent edits, navigation changes, pull requests

Connect to the Mintlify MCP

Find your Mintlify MCP URL on the MCP server page in your dashboard. Connecting requires an interactive OAuth login against your Mintlify account. The AI tool exchanges that login for a session token scoped to one project.
1

Add the Mintlify MCP as a custom connector

  1. Navigate to the Connectors page in the Claude settings.
  2. Select Add custom connector.
  3. Add your Mintlify MCP server name and URL.
  4. Select Add and complete the OAuth login.
2

Use the MCP in a chat

Select the attachments button (the plus icon) and choose your Mintlify MCP server. Claude can now call the Mintlify MCP tools while answering your prompt.

How a session works

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

Check out a branch

The first call must be checkout. It creates a fresh mintlify-mcp/<slug>-<sha> branch from your deploy branch (or attaches to an existing branch you name) and returns an editorUrl you can open to follow along in the dashboard editor.
2

Read, search, and edit

The AI uses tools like search, read, list_nodes, edit_page, write_page, create_node, and update_config to make changes. All edits buffer on the session branch in real time—nothing touches your deploy branch yet.
3

Review the diff

Call diff at any time to see exactly what changed since main. Open the editorUrl in your dashboard to see the same changes rendered.
4

Save

Call save to flush the branch to Git. Use mode: "pr" (default) to open a pull request, or mode: "commit" to push directly to an existing PR branch.
5

Discard if needed

Call discard_session to drop all in-session changes and release the branch.
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.

What the Mintlify MCP can do

Content

  • read — Fetch the full MDX of any page on the session branch.
  • search — Find lines matching a substring or regex across every page.
  • edit_page — Apply a targeted edit to a page.
  • write_page — Overwrite a page’s full MDX content.
  • list_nodes — Walk the navigation tree, filtered by type, language, version, or tab.
  • 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.
  • delete_node — Remove a node from the navigation.

Configuration

  • update_config — Modify docs.json (theme, navigation roots, integrations, SEO settings).

Session

  • checkout — Bind the session to a branch.
  • get_session_state — Inspect the current branch, edited files, and pending nav diff.
  • diff — List all changes between the session and main.
  • save — Open a pull request or commit to the session branch.
  • discard_session — Drop the session and its in-flight changes.

Example prompts

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’.”
  • “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.”

Best practices

Every checkout returns an editorUrl. Open it in a separate tab so you can watch the AI’s changes render live in the dashboard editor while you prompt.
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.
Pass a slug to checkout (for example, add-quickstart) so the auto-generated branch is human-readable. Without it, the branch name derives from the session token and is hard to recognize in your repository.
Keep each session focused to one change. Smaller sessions produce easier to review pull requests and preserve agents’ context windows. Use discard_session and checkout again to pivot to unrelated work.
Sessions hold an in-memory branch on the Mintlify side. If you abandon a session without saving or discarding it, the branch persists until your next checkout overwrites it. Avoid leaving stale mintlify-mcp/* branches in your repository. Clean them up periodically.