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, updatedocs.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 MCP | Mintlify MCP | |
|---|---|---|
| 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 |
| Output | Search results and page content | Content 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.- Claude
- Claude Code
- Cursor
Add the Mintlify MCP as a custom connector
- Navigate to the Connectors page in the Claude settings.
- Select Add custom connector.
- Add your Mintlify MCP server name and URL.
- Select Add and complete the OAuth login.
How a session works
Every Mintlify MCP session binds to a single Git branch. The flow is: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.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.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.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.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.
Navigation
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— Modifydocs.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 andmain.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-faqand 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_tokenfield and update the example to useapi_keyinstead. 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
Open the editor URL
Open the editor URL
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.Review every PR
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.
Use slugs for branch names
Use slugs for branch names
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 sessions focused
Keep sessions focused
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.