Skip to content
Merged
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
8 changes: 4 additions & 4 deletions ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,12 @@
If your connection has access to more than one project, call `list_deployments` to see which `subdomain` values you can check out. Skip this step if your connection covers only a single project.
</Step>
<Step title="Check out a branch">
The first required call is `checkout {subdomain}`. It creates a fresh `admin-mcp/<slug>-<sha>` branch from that project's deploy branch (or attaches to an existing branch you name) and returns an `editorUrl` you can open to follow along in the dashboard editor.
The first required call is `checkout {subdomain}`. It creates a fresh `admin-mcp/<slug>-<sha>` branch from that project's deploy branch (or attaches to an existing branch you name). It also returns an `editorUrl` you can open to follow along in the dashboard editor.

Call `list_branches` before `checkout` if you need to discover or filter existing branches in a project's repository.
</Step>
<Step title="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.
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.
</Step>
<Step title="Review the diff">
Call `diff` at any time to see exactly what changed since your deploy branch. Open an `editorUrl` in your dashboard to see the same changes rendered. When `create_node` adds a page, it returns an `editorUrl` that opens that page directly.
Expand All @@ -140,7 +140,7 @@

This toggle shares the same `agentReviewProcess` setting as the Slack and dashboard agent, so any change here also applies to those flows.

The toggle is disabled in three cases:

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L143

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

- **Your deploy branch requires a pull request.** If branch protection rules or required approvals prevent direct pushes, MCP changes always open a pull request regardless of this setting.
- **Mintlify hosts your project.** For Mintlify-hosted sites, MCP changes always push directly, unless branch protection still requires a pull request.
Expand All @@ -152,18 +152,18 @@

### Content

- **`read`**: Fetch the full MDX of any page on the session branch. Pass in a file path or uuid. To read a [private page](/editor/pages#private-pages), pass its `private-page-<uuid>` node id from `list_nodes` with `visibility: "private"`. Private reads work without a checkout and require an OAuth session. The admin MCP rejects client and machine-to-machine tokens for private-page access.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L155

Use 'UUID' instead of 'uuid'.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L155

Use 'IDs?' instead of 'id'.
- **`search`**: Find lines matching a substring or regular expression across every page.
- **`edit_page`**: Apply a targeted edit to a page. To edit a [private page](/editor/pages#private-pages), pass its `private-page-<uuid>` node id as `path`. Private edits require an OAuth session with an editor role or higher on the page and work without a checkout.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L157

Use 'IDs?' instead of 'id'.
- **`write_page`**: Overwrite a page's full MDX content. Accepts a `private-page-<uuid>` node id to overwrite a private page under the same OAuth and role requirements as `edit_page`. Use `create_node` to create a new private page.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L158

Use 'IDs?' instead of 'id'.

### 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 paginate through an opaque `cursor`. Pass `visibility: "private"` to list the [private pages](/editor/pages#private-pages) and folders the OAuth user can access instead of the branch nav tree. Private listing works without a checkout, ignores the other filters, and returns each node's `role`.
- **`create_node`**: Add a new page, group, tab, anchor, version, language, product, or dropdown. Pass `visibility: "private"` with `data.type: "page"` or `data.type: "group"` to create a [private page](/editor/pages#private-pages) or private folder in the caller's private tree. The caller becomes the node's manager. Private creation requires an OAuth session, works without a checkout, and places the node at the private root or under an existing `private-folder-<uuid>` parent. For new pages on the session branch, the response includes an `editorUrl` that opens the page in the dashboard editor.
- **`update_node`**: Update a node's properties in place (rename a group, change an icon, set a default version). Accepts a `private-page-<uuid>` or `private-folder-<uuid>` node id to rename a [private page](/editor/pages#private-pages) or folder or change its icon or tag. Private updates require an OAuth session with an editor role or higher and work without a checkout.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L164

Use 'IDs?' instead of 'id'.
- **`move_node`**: Move a node, including renaming a page's path.
- **`delete_node`**: Remove a node from the navigation. Accepts a `private-page-<uuid>` or `private-folder-<uuid>` node id to delete a [private page](/editor/pages#private-pages) or folder from the caller's private tree. Private deletions require an OAuth session with a manager role on the node and work without a checkout.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L166

Use 'IDs?' instead of 'id'.

If a `create_node`, `update_node`, `move_node`, or `delete_node` call leaves the navigation in an invalid state, the response includes a `navigationErrors` field that describes the problem. For example, a page placed at the root next to tabs returns `navigationErrors`. Mintlify can drop invalid nodes from the published navigation, so fix these errors before you call `save`.

Expand All @@ -189,7 +189,7 @@
- **`list_branches`**: List Git branches available for a project's repository, with optional `query` filtering. Returns the branch names, total count, and the deploy branch. Call this before `checkout` to attach to an existing branch by name.
- **`get_session_state`**: Inspect the current branch, edited files, and pending nav diff.
- **`diff`**: List all changes between the session and your deploy branch.
- **`save`**: Open a pull request or commit to the session branch. If your project allows the agent to push to main and you have no branch protection rules, auto-merges the PR.
- **`save`**: Open a pull request or commit to the session branch. If your project allows the agent to push to main and you have no branch protection rules, Mintlify auto-merges the PR.
- **`discard_session`**: Drop the session and its in-flight changes.

## Example prompts
Expand All @@ -208,7 +208,7 @@
</Accordion>

<Accordion title="Review every PR">
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.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L211

Cut or rephrase 'powerful'. See 'Phrases to cut' in the style guide.
</Accordion>

<Accordion title="Use slugs for branch names">
Expand Down Expand Up @@ -236,4 +236,4 @@
- Cursor: delete the `mintlify` entry from `mcp.json` and reload.
- Codex: delete the `[mcp_servers.mintlify]` block from `~/.codex/config.toml`.

Revoking the OAuth grant does not affect pull requests the MCP has already opened. Close or revert those PRs in your Git provider if you want to undo pending changes.
Revoking the OAuth grant doesn't affect pull requests the MCP has already opened. Close or revert those PRs in your Git provider if you want to undo pending changes.
Loading