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
4 changes: 2 additions & 2 deletions ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@

The AI tool acts as you on the deploy branch:

- **Edits are live to collaborators.** Anyone else editing the deploy branch in the dashboard sees the AI's changes as they happen.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L110

Did you really mean 'ato'?
- **`publish` publishes only your changes.** It commits your pending changes straight to the deploy branch, like clicking **Publish** in the editor. Other people's unpublished changes stay pending. Your own unpublished edits from the dashboard editor publish too.
- **`discard` reverts only your changes.** It returns `discardedChanges` with the number of changes it reverted. Other people's changes and the branch itself stay untouched.
- **`status` lists only your changes.**
Expand All @@ -120,10 +120,10 @@

- **Push directly to your deploy branch** is off in your [publishing settings](#publishing).
- Branch protection on your deploy branch requires pull requests, or Mintlify can't check your branch protection rules.
- Editing the deploy branch is locked in the dashboard editor.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L123

In general, use active voice instead of passive voice ('is locked').
- You connected with a client or machine-to-machine token instead of an OAuth login. These tokens aren't tied to a user, so they have no "own" changes.

Mintlify checks these conditions on every edit and caches your branch protection rules for up to 30 seconds. Comment tools still work on the deploy branch when edits to it are refused. If your deploy branch starts requiring a pull request after you edit it, `publish` returns `branch_protected` and your changes stay pending. Open the dashboard editor to move them to a new branch.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L126

In general, use active voice instead of passive voice ('are refused').

## Work on a branch

Expand All @@ -143,7 +143,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 146 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L146

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 go through 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 Down Expand Up @@ -173,8 +173,8 @@

- **`read`**: Fetch the full MDX of any page on `branch`, or on your deploy branch when you omit it. 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 don't need a `branch` and require an OAuth session. The admin MCP rejects client and machine-to-machine tokens for private-page access.
- **`search`**: Find lines matching a substring or regular expression across every page on `branch`. Searches your deploy branch when you omit it.
- **`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 don't need a `branch`.
- **`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.
- **`edit_page`**: Apply a targeted edit to a page. Pass `oldString` and `newString` for one replacement, or pass an `edits` list of up to 100 replacements to change several parts of a page in one call. Mintlify applies the edits in order, each to the result of the previous one. If any edit fails, none of them apply. Like `write_page`, `edit_page` returns `notRendered` for markup the edit adds that the editor drops. It doesn't report markup that was already on the 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 don't need a `branch`.
- **`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. If the content includes markup the Mintlify editor drops, such as `<script>` tags, `<style>` blocks, event handlers like `onClick`, or JavaScript expressions, the response includes a `notRendered` field. Each entry lists the dropped `element`, its `line`, `why` the editor drops it, and what to use `instead`, such as Tailwind classes, inline `style={{}}` objects with literal values, or Mintlify components like accordions and tabs.

### Images

Expand Down
Loading