docs: add admin MCP page#5587
Conversation
Mintlify-Source: dashboard-editor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
left a comment
There was a problem hiding this comment.
just requesting changes to confirm the name
| @@ -0,0 +1,157 @@ | |||
| --- | |||
| title: "Admin MCP" | |||
There was a problem hiding this comment.
Are we confirmed naming this Admin MCP?
| @@ -0,0 +1,157 @@ | |||
| --- | |||
| title: "Admin MCP" | |||
| description: "Let AI tools edit your Mintlify documentation directly with the admin MCP server. Connect Claude, Cursor, or any MCP client to draft, save, and ship doc changes." | |||
There was a problem hiding this comment.
| description: "Let AI tools edit your Mintlify documentation directly with the admin MCP server. Connect Claude, Cursor, or any MCP client to draft, save, and ship doc changes." | |
| 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." |
TBD on the confirmed name
| --- | ||
| title: "Admin MCP" | ||
| description: "Let AI tools edit your Mintlify documentation directly with the admin MCP server. Connect Claude, Cursor, or any MCP client to draft, save, and ship doc changes." | ||
| keywords: ["admin MCP", "write access", "AI editing", "Claude", "Cursor", "branch", "pull request"] |
There was a problem hiding this comment.
| keywords: ["admin MCP", "write access", "AI editing", "Claude", "Cursor", "branch", "pull request"] | |
| keywords: ["MCP", "write access", "AI", "editing", "Claude", "Cursor", "branch", "pull request"] |
|
|
||
| ## About the admin MCP | ||
|
|
||
| The admin MCP server gives AI tools write access to your Mintlify documentation. Where the [documentation MCP server](/ai/model-context-protocol) lets AI tools read and search your published docs, the admin MCP lets them propose changes: edit pages, restructure navigation, update `docs.json`, and open pull requests. |
There was a problem hiding this comment.
| The admin MCP server gives AI tools write access to your Mintlify documentation. Where the [documentation MCP server](/ai/model-context-protocol) lets AI tools read and search your published docs, the admin 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. Where the [documentation MCP server](/ai/model-context-protocol) lets AI tools read and search your published content, the admin MCP lets them propose changes: edit pages, restructure navigation, update `docs.json`, and open pull requests. |
Starting to replace documentation with content as part of expanding to cover more use cases.
|
|
||
| The admin MCP server gives AI tools write access to your Mintlify documentation. Where the [documentation MCP server](/ai/model-context-protocol) lets AI tools read and search your published docs, the admin 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 admin MCP and your assistant can collaborate with you on docs the same way it collaborates on code — except every change runs through a Mintlify branch and lands in your repository as a pull request. |
There was a problem hiding this comment.
| Connect any MCP client like Claude, Claude Code, or Cursor to the admin MCP and your assistant can collaborate with you on docs the same way it collaborates on code — except every change runs through a Mintlify branch and lands in your repository as a pull request. | |
| Connect any MCP client like Claude, Claude Code, or Cursor to the admin 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. |
| </Accordion> | ||
|
|
||
| <Accordion title="Use slugs for branch names"> | ||
| Pass a `slug` to `checkout` (e.g. `add-quickstart`) so the auto-generated branch is human-readable. Without it, the branch name is derived from the session token and is hard to recognize in your repo. |
There was a problem hiding this comment.
| Pass a `slug` to `checkout` (e.g. `add-quickstart`) so the auto-generated branch is human-readable. Without it, the branch name is derived from the session token and is hard to recognize in your repo. | |
| 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. |
| </Accordion> | ||
|
|
||
| <Accordion title="Keep sessions focused"> | ||
| One session, one logical change. Smaller sessions produce smaller, easier-to-review pull requests. Use `discard_session` and `checkout` again to pivot to unrelated work. |
There was a problem hiding this comment.
| One session, one logical change. Smaller sessions produce smaller, easier-to-review pull requests. Use `discard_session` and `checkout` again to pivot to unrelated work. | |
| 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. |
| </AccordionGroup> | ||
|
|
||
| <Warning> | ||
| Sessions hold an in-memory branch on the Mintlify side. If a session is abandoned without a `save` or `discard_session`, the branch persists until your next checkout overwrites it. Avoid leaving stale `admin-mcp/*` branches in your repository — clean them up periodically. |
There was a problem hiding this comment.
| Sessions hold an in-memory branch on the Mintlify side. If a session is abandoned without a `save` or `discard_session`, the branch persists until your next checkout overwrites it. Avoid leaving stale `admin-mcp/*` branches in your repository — clean them up periodically. | |
| 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 `admin-mcp/*` branches in your repository. Clean them up periodically. |
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| <Warning> |
There was a problem hiding this comment.
| <Warning> | |
| <Note> |
Changing to a note since this isn't really destructive, just clutter
|
|
||
| <Warning> | ||
| Sessions hold an in-memory branch on the Mintlify side. If a session is abandoned without a `save` or `discard_session`, the branch persists until your next checkout overwrites it. Avoid leaving stale `admin-mcp/*` branches in your repository — clean them up periodically. | ||
| </Warning> No newline at end of file |
There was a problem hiding this comment.
| </Warning> | |
| </Note> |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 2ef0590. Configure here.
| "agent/use-cases" | ||
| ] | ||
| }, | ||
| "ai/mintlify-mcp", |
There was a problem hiding this comment.
Page placed in wrong navigation section
High Severity
The ai/mintlify-mcp entry is added inside the "Create content" group (between the Agent subgroup and the Components subgroup), but the PR description states it belongs in the "Optimize" section right after ai/model-context-protocol. The page will render in the wrong place in the site navigation, making it hard for users to discover.
Reviewed by Cursor Bugbot for commit 2ef0590. Configure here.


Adds a new page at
/ai/admin-mcpcovering what the admin MCP server is, how it differs from the read-only documentation MCP, how to connect Claude / Claude Code / Cursor, the session lifecycle (checkout → edit → diff → save), the full tool catalog, example prompts, and best practices.Sits in the Optimize section right after Model Context Protocol.
Mintlify
0 threads from 0 users in Mintlify
Note
Cursor Bugbot is generating a summary for commit 9114d98. Configure here.