Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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,19 +152,21 @@

### 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`.

### Configuration

- **`update_config`**: Modify `docs.json` (theme, navigation roots, integrations, SEO settings).
Expand Down Expand Up @@ -206,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
2 changes: 2 additions & 0 deletions es/ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ También puedes anular el ajuste caso por caso pasando un `mode` explícito a `s
- **`move_node`**: Mueve un nodo, incluido renombrar la ruta de una página.
- **`delete_node`**: Elimina un nodo de la navegación. Acepta un ID de nodo `private-page-<uuid>` o `private-folder-<uuid>` para eliminar una [página privada](/es/editor/pages#private-pages) o carpeta del árbol privado del autor de la llamada. Las eliminaciones privadas requieren una sesión OAuth con rol de manager en el nodo y funcionan sin un checkout.

Si una llamada a `create_node`, `update_node`, `move_node` o `delete_node` deja la navegación en un estado no válido, la respuesta incluye un campo `navigationErrors` que describe el problema. Por ejemplo, una página colocada en la raíz junto a pestañas devuelve `navigationErrors`. Mintlify puede omitir los nodos no válidos de la navegación publicada, así que corrige estos errores antes de llamar a `save`.

<div id="configuration">
### Configuración
</div>
Expand Down
2 changes: 2 additions & 0 deletions fr/ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ Vous pouvez également remplacer ce paramètre appel par appel en passant un `mo
- **`move_node`**: Déplace un nœud, y compris renommer le chemin d'une page.
- **`delete_node`**: Supprime un nœud de la navigation. Accepte un ID de nœud `private-page-<uuid>` ou `private-folder-<uuid>` pour supprimer une [page privée](/fr/editor/pages#private-pages) ou un dossier de l'arbre privé de l'appelant. Les suppressions privées nécessitent une session OAuth avec un rôle de manager sur le nœud et fonctionnent sans checkout.

Si un appel à `create_node`, `update_node`, `move_node` ou `delete_node` laisse la navigation dans un état invalide, la réponse inclut un champ `navigationErrors` qui décrit le problème. Par exemple, une page placée à la racine à côté d'onglets renvoie `navigationErrors`. Mintlify peut retirer les nœuds invalides de la navigation publiée. Corrigez donc ces erreurs avant d'appeler `save`.

<div id="configuration">
### Configuration
</div>
Expand Down
2 changes: 2 additions & 0 deletions zh/ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ keywords: ["MCP", "写入权限", "AI", "编辑", "Claude", "ChatGPT", "Cursor",
- **`move_node`**: 移动节点,包括重命名页面的路径。
- **`delete_node`**: 从导航中移除节点。可接受 `private-page-<uuid>` 或 `private-folder-<uuid>` 节点 ID,用于从调用者的私有树中删除[私有页面](/zh/editor/pages#private-pages)或私有文件夹。私有删除需要在该节点上具有 manager 角色的 OAuth 会话,且无需 checkout。

如果 `create_node`、`update_node`、`move_node` 或 `delete_node` 调用使导航处于无效状态,响应中会包含描述该问题的 `navigationErrors` 字段。例如,将页面放在根级别并与 tab 并列时会返回 `navigationErrors`。Mintlify 可能会从已发布的导航中移除无效节点,因此请在调用 `save` 之前修复这些错误。

<div id="configuration">
### 配置
</div>
Expand Down
Loading