diff --git a/agent-context/context/skills/mintlify/SKILL.md b/agent-context/context/skills/mintlify/SKILL.md index 62dd63409..a6efa5105 100644 --- a/agent-context/context/skills/mintlify/SKILL.md +++ b/agent-context/context/skills/mintlify/SKILL.md @@ -42,7 +42,7 @@ Use this server when the user wants to edit their Mintlify content, restructure Workflow: call `checkout` first (always), then use `read`/`search`/`edit_page`/`write_page`/`list_nodes`/`create_node`/`update_node`/`move_node`/`delete_node`/`update_config` to make changes, then call `save` to publish (or `discard_session` to abandon). Key tools: -- **`checkout`** — Start a session on a branch (required first call). Returns an `editorUrl` to preview changes live. +- **`checkout`** — Start a session on a branch (required first call). Returns a branch-level `editorUrl` to preview changes live. - **`list_branches`** — List existing branches; call before `checkout` to attach to one. - **`list_deployments`** — Discover which project(s) this connection can access. - **`read`** / **`search`** — Fetch a page's MDX or search across pages. @@ -54,10 +54,10 @@ Key tools: Private pages: `list_nodes` accepts `visibility: "private"` to list the private pages and folders the OAuth user can access (ignores other filters, returns each node's `role`). `read`, `edit_page`, `write_page`, `update_node`, and `delete_node` accept `private-page-` or `private-folder-` node ids; `create_node` accepts `visibility: "private"` with `data.type: "page"` or `"group"`. Private-page operations require an OAuth session (the admin MCP rejects client and machine-to-machine tokens), work without a `checkout`, and enforce role requirements: read for reads, editor or higher for writes and updates, manager for deletes. The caller becomes the manager of any node they create. - **`diff`** — See all changes relative to the deploy branch. - **`get_session_state`** — Check the current session's status. -- **`save`** — Publish the session. `mode: "auto"` (default) opens a PR, and Mintlify merges it immediately when the project's publishing setting allows direct pushes and the deploy branch isn't protected. `mode: "pr"` always opens a PR and leaves it open for review. `mode: "commit"` pushes to an existing PR branch without opening a new PR. Changing the publishing setting in the dashboard requires the admin role. +- **`save`** — Publish the session. `mode: "auto"` (default) opens a PR, and Mintlify merges it immediately when the project's publishing setting allows direct pushes and the deploy branch isn't protected. `mode: "pr"` always opens a PR and leaves it open for review. `mode: "commit"` pushes to an existing PR branch without opening a new PR. Changing the publishing setting in the dashboard requires the admin role. Unless the save merges immediately, the response includes an `editorUrl` that opens the first created or updated page. - **`discard_session`** — Drop all in-session changes. -Keep each session focused on one change. Smaller sessions produce easier-to-review PRs. Open the `editorUrl` to watch changes render live. +Keep each session focused on one change. Smaller sessions produce easier-to-review PRs. Open the `editorUrl` to watch changes render live. Prefer the page-level `editorUrl` from `create_node` or `save` over the one from `checkout`. ## Before you start diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index eb13d4fcc..52fa5083f 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -116,10 +116,12 @@ Every admin MCP session binds to a single Git branch. The flow is: 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. - Call `diff` at any time to see exactly what changed since your deploy branch. Open the `editorUrl` in your dashboard to see the same changes rendered. + 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. Call `save` to flush the branch to Git. `mode: "auto"` (default) opens a pull request. If the project's agent review setting is push-to-main and the deploy branch isn't protected, Mintlify merges the pull request immediately (the response includes `merged: true`). Use `mode: "pr"` to always open a pull request and leave it open for review. Use `mode: "commit"` to push directly to an existing PR branch without opening a new PR. + + When `save` opens or updates a pull request, the response includes an `editorUrl` that opens the first created or updated page on the branch. If the changes only touch configuration, the link opens the branch. Saves that merge immediately don't return an `editorUrl`. Call `discard_session` to drop all in-session changes and release the branch. @@ -158,7 +160,7 @@ You can also override the setting on a per-call basis by passing an explicit `mo ### 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-` parent. +- **`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-` 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-` or `private-folder-` 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. - **`move_node`**: Move a node, including renaming a page's path. - **`delete_node`**: Remove a node from the navigation. Accepts a `private-page-` or `private-folder-` 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. @@ -200,7 +202,7 @@ After you connect the admin MCP, you can drive it with natural-language prompts. - 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. + `checkout` returns an `editorUrl` for the branch. `create_node` and `save` return an `editorUrl` for the page that changed. Open these links in a separate tab so you can watch the AI's changes render live in the dashboard editor while you prompt. diff --git a/es/ai/mintlify-mcp.mdx b/es/ai/mintlify-mcp.mdx index a9147843f..4b0e306f5 100644 --- a/es/ai/mintlify-mcp.mdx +++ b/es/ai/mintlify-mcp.mdx @@ -126,10 +126,12 @@ Cada sesión del Admin MCP se vincula a una sola rama de Git. El flujo es: La IA usa herramientas como `search`, `read`, `list_nodes`, `edit_page`, `write_page`, `create_node` y `update_config` para realizar cambios. Todas las ediciones se mantienen en la rama de la sesión en tiempo real; nada toca aún tu rama de despliegue. - Llama a `diff` en cualquier momento para ver exactamente qué ha cambiado desde tu rama de despliegue. Abre el `editorUrl` en tu panel para ver los mismos cambios renderizados. + Llama a `diff` en cualquier momento para ver exactamente qué ha cambiado desde tu rama de despliegue. Abre un `editorUrl` en tu panel para ver los mismos cambios renderizados. Cuando `create_node` agrega una página, devuelve un `editorUrl` que abre esa página directamente. Llama a `save` para enviar la rama a Git. `mode: "auto"` (predeterminado) abre una pull request y, si la configuración de revisión del agente del proyecto es push-to-main y la rama de despliegue no está protegida, la fusiona de inmediato (la respuesta incluye `merged: true`). Usa `mode: "pr"` para abrir siempre una pull request y dejarla abierta para revisión, o `mode: "commit"` para hacer push directamente a una rama de PR existente sin abrir una nueva PR. + + Cuando `save` abre o actualiza una pull request, la respuesta incluye un `editorUrl` que abre la primera página creada o actualizada en la rama. Si los cambios solo afectan a la configuración, el enlace abre la rama. Los guardados que se fusionan de inmediato no devuelven un `editorUrl`. Llama a `discard_session` para descartar todos los cambios en la sesión y liberar la rama. @@ -176,7 +178,7 @@ También puedes anular el ajuste caso por caso pasando un `mode` explícito a `s - **`list_nodes`**: Recorre el árbol de navegación con filtros opcionales. Filtra por `parentId` (usa `recursive: true` para incluir todos los descendientes), uno o más tipos de nodo, o cualquier ámbito de división: `language`, `version`, `tab`, `dropdown`, `anchor`, `product` o `item`. Los resultados se paginan a través de un `cursor` opaco. Pasa `visibility: "private"` para listar las [páginas privadas](/es/editor/pages#private-pages) y carpetas a las que el usuario OAuth tiene acceso, en lugar del árbol de navegación de la rama. El listado privado funciona sin un checkout, ignora los demás filtros y devuelve el `role` de cada nodo. -- **`create_node`**: Agrega una nueva página, grupo, pestaña, ancla, versión, idioma, producto o desplegable. Pasa `visibility: "private"` con `data.type: "page"` o `data.type: "group"` para crear una [página privada](/es/editor/pages#private-pages) o carpeta privada en el árbol privado del autor de la llamada. El autor de la llamada se convierte en el manager del nodo. La creación privada requiere una sesión OAuth, funciona sin un checkout y coloca el nodo en la raíz privada o bajo un padre `private-folder-` existente. +- **`create_node`**: Agrega una nueva página, grupo, pestaña, ancla, versión, idioma, producto o desplegable. Pasa `visibility: "private"` con `data.type: "page"` o `data.type: "group"` para crear una [página privada](/es/editor/pages#private-pages) o carpeta privada en el árbol privado del autor de la llamada. El autor de la llamada se convierte en el manager del nodo. La creación privada requiere una sesión OAuth, funciona sin un checkout y coloca el nodo en la raíz privada o bajo un padre `private-folder-` existente. Para las páginas nuevas en la rama de la sesión, la respuesta incluye un `editorUrl` que abre la página en el editor del panel. - **`update_node`**: Actualiza las propiedades de un nodo en su lugar (renombrar un grupo, cambiar un icono, establecer una versión predeterminada). Acepta un ID de nodo `private-page-` o `private-folder-` para renombrar una [página privada](/es/editor/pages#private-pages) o carpeta o cambiar su icono o etiqueta. Las actualizaciones privadas requieren una sesión OAuth con rol de editor o superior y funcionan sin un checkout. - **`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-` o `private-folder-` 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. @@ -228,7 +230,7 @@ Después de conectarte al Admin MCP, puedes manejarlo con prompts en lenguaje na - Cada `checkout` devuelve un `editorUrl`. Ábrelo en una pestaña aparte para ver cómo se renderizan los cambios de la IA en vivo en el editor del panel mientras escribes prompts. + `checkout` devuelve un `editorUrl` para la rama. `create_node` y `save` devuelven un `editorUrl` para la página que cambió. Abre estos enlaces en una pestaña aparte para ver cómo se renderizan los cambios de la IA en vivo en el editor del panel mientras escribes prompts. diff --git a/fr/ai/mintlify-mcp.mdx b/fr/ai/mintlify-mcp.mdx index b45ce2507..a73677fc8 100644 --- a/fr/ai/mintlify-mcp.mdx +++ b/fr/ai/mintlify-mcp.mdx @@ -126,10 +126,12 @@ Chaque session Admin MCP est liée à une seule branche Git. Le flux est le suiv L'IA utilise des outils tels que `search`, `read`, `list_nodes`, `edit_page`, `write_page`, `create_node` et `update_config` pour effectuer des modifications. Toutes les modifications sont mises en mémoire tampon sur la branche de session en temps réel — rien ne touche encore votre branche de déploiement. - Appelez `diff` à tout moment pour voir exactement ce qui a changé depuis votre branche de déploiement. Ouvrez l'`editorUrl` dans votre tableau de bord pour voir les mêmes changements rendus. + Appelez `diff` à tout moment pour voir exactement ce qui a changé depuis votre branche de déploiement. Ouvrez une `editorUrl` dans votre tableau de bord pour voir les mêmes changements rendus. Lorsque `create_node` ajoute une page, il renvoie une `editorUrl` qui ouvre directement cette page. Appelez `save` pour pousser la branche vers Git. `mode: "auto"` (par défaut) ouvre une pull request et, si le paramètre de revue de l'agent du projet est push-to-main et que la branche de déploiement n'est pas protégée, la fusionne immédiatement (la réponse inclut `merged: true`). Utilisez `mode: "pr"` pour toujours ouvrir une pull request et la laisser ouverte pour révision, ou `mode: "commit"` pour pousser directement sur une branche de PR existante sans ouvrir de nouvelle PR. + + Lorsque `save` ouvre ou met à jour une pull request, la réponse inclut une `editorUrl` qui ouvre la première page créée ou modifiée sur la branche. Si les changements ne concernent que la configuration, le lien ouvre la branche. Les sauvegardes fusionnées immédiatement ne renvoient pas d'`editorUrl`. Appelez `discard_session` pour abandonner toutes les modifications en session et libérer la branche. @@ -176,7 +178,7 @@ Vous pouvez également remplacer ce paramètre appel par appel en passant un `mo - **`list_nodes`**: Parcourt l'arbre de navigation avec des filtres optionnels. Filtrez par `parentId` (utilisez `recursive: true` pour inclure tous les descendants), un ou plusieurs types de nœuds, ou n'importe quel scope de division : `language`, `version`, `tab`, `dropdown`, `anchor`, `product` ou `item`. Les résultats se paginent via un `cursor` opaque. Transmettez `visibility: "private"` pour lister les [pages privées](/fr/editor/pages#private-pages) et dossiers auxquels l'utilisateur OAuth a accès, au lieu de l'arbre de navigation de la branche. Le listing privé fonctionne sans checkout, ignore les autres filtres et renvoie le `role` de chaque nœud. -- **`create_node`**: Ajoute une nouvelle page, un groupe, un onglet, une ancre, une version, une langue, un produit ou une liste déroulante. Transmettez `visibility: "private"` avec `data.type: "page"` ou `data.type: "group"` pour créer une [page privée](/fr/editor/pages#private-pages) ou un dossier privé dans l'arbre privé de l'appelant. L'appelant devient le manager du nœud. La création privée nécessite une session OAuth, fonctionne sans checkout et place le nœud à la racine privée ou sous un parent `private-folder-` existant. +- **`create_node`**: Ajoute une nouvelle page, un groupe, un onglet, une ancre, une version, une langue, un produit ou une liste déroulante. Transmettez `visibility: "private"` avec `data.type: "page"` ou `data.type: "group"` pour créer une [page privée](/fr/editor/pages#private-pages) ou un dossier privé dans l'arbre privé de l'appelant. L'appelant devient le manager du nœud. La création privée nécessite une session OAuth, fonctionne sans checkout et place le nœud à la racine privée ou sous un parent `private-folder-` existant. Pour les nouvelles pages sur la branche de session, la réponse inclut une `editorUrl` qui ouvre la page dans l'éditeur du tableau de bord. - **`update_node`**: Met à jour les propriétés d'un nœud sur place (renommer un groupe, modifier une icône, définir une version par défaut). Accepte un ID de nœud `private-page-` ou `private-folder-` pour renommer une [page privée](/fr/editor/pages#private-pages) ou un dossier, ou changer son icône ou son tag. Les mises à jour privées nécessitent une session OAuth avec un rôle d'editor ou supérieur et fonctionnent sans checkout. - **`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-` ou `private-folder-` 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. @@ -228,7 +230,7 @@ Une fois l'Admin MCP connecté, vous pouvez le piloter avec des prompts en langa - Chaque `checkout` renvoie une `editorUrl`. Ouvrez-la dans un onglet séparé pour pouvoir voir les modifications de l'IA s'afficher en direct dans l'éditeur du tableau de bord pendant que vous rédigez vos prompts. + `checkout` renvoie une `editorUrl` pour la branche. `create_node` et `save` renvoient une `editorUrl` pour la page modifiée. Ouvrez ces liens dans un onglet séparé pour pouvoir voir les modifications de l'IA s'afficher en direct dans l'éditeur du tableau de bord pendant que vous rédigez vos prompts. diff --git a/zh/ai/mintlify-mcp.mdx b/zh/ai/mintlify-mcp.mdx index d2fd393e9..de06a9d4b 100644 --- a/zh/ai/mintlify-mcp.mdx +++ b/zh/ai/mintlify-mcp.mdx @@ -126,10 +126,12 @@ keywords: ["MCP", "写入权限", "AI", "编辑", "Claude", "ChatGPT", "Cursor", AI 使用 `search`、`read`、`list_nodes`、`edit_page`、`write_page`、`create_node` 和 `update_config` 等工具进行更改。所有编辑都会实时缓冲在会话 branch 上——目前还不会影响你的部署 branch。 - 随时调用 `diff` 查看与你的部署 branch 相比发生了哪些更改。在控制台中打开 `editorUrl`，可以看到相同更改的渲染效果。 + 随时调用 `diff` 查看与你的部署 branch 相比发生了哪些更改。在控制台中打开 `editorUrl`，可以看到相同更改的渲染效果。当 `create_node` 添加页面时，会返回一个直接打开该页面的 `editorUrl`。 调用 `save` 将 branch 推送到 Git。`mode: "auto"`（默认值）会创建一个拉取请求；如果该项目的 agent review 设置为 push-to-main 且部署 branch 未受保护，则会立即将其合并（响应中包含 `merged: true`）。使用 `mode: "pr"` 始终创建拉取请求并保持其打开以供审查，或使用 `mode: "commit"` 直接推送到现有的 PR branch，而不打开新的 PR。 + + 当 `save` 创建或更新拉取请求时，响应中会包含一个 `editorUrl`，用于打开该 branch 上第一个新建或更新的页面。如果更改只涉及配置，该链接会打开 branch。立即合并的保存不会返回 `editorUrl`。 调用 `discard_session` 丢弃所有会话内更改并释放该 branch。 @@ -176,7 +178,7 @@ keywords: ["MCP", "写入权限", "AI", "编辑", "Claude", "ChatGPT", "Cursor", - **`list_nodes`**: 遍历导航树，可使用可选筛选条件。按 `parentId` 筛选 (使用 `recursive: true` 包含所有后代)、按一个或多个节点类型筛选，或按任意分区范围筛选：`language`、`version`、`tab`、`dropdown`、`anchor`、`product` 或 `item`。结果通过不透明的 `cursor` 分页。传入 `visibility: "private"` 可以列出 OAuth 用户有权访问的[私有页面](/zh/editor/pages#private-pages)和文件夹，而不是 branch 的导航树。私有列表无需 checkout，会忽略其他筛选条件，并返回每个节点的 `role`。 -- **`create_node`**: 添加新的页面、组、tab、anchor、版本、语言、产品或 dropdown。传入 `visibility: "private"` 并配合 `data.type: "page"` 或 `data.type: "group"`，可在调用者的私有树中创建[私有页面](/zh/editor/pages#private-pages)或私有文件夹。调用者会成为该节点的 manager。私有创建需要 OAuth 会话，无需 checkout，并会将节点放在私有根目录下，或放在现有的 `private-folder-` 父节点下。 +- **`create_node`**: 添加新的页面、组、tab、anchor、版本、语言、产品或 dropdown。传入 `visibility: "private"` 并配合 `data.type: "page"` 或 `data.type: "group"`，可在调用者的私有树中创建[私有页面](/zh/editor/pages#private-pages)或私有文件夹。调用者会成为该节点的 manager。私有创建需要 OAuth 会话，无需 checkout，并会将节点放在私有根目录下，或放在现有的 `private-folder-` 父节点下。对于会话 branch 上的新页面，响应中会包含一个在控制台编辑器中打开该页面的 `editorUrl`。 - **`update_node`**: 就地更新节点属性 (重命名组、更改图标、设置默认版本)。可接受 `private-page-` 或 `private-folder-` 节点 ID，用于重命名[私有页面](/zh/editor/pages#private-pages)或私有文件夹，或更改其图标或 tag。私有更新需要具有 editor 或更高角色的 OAuth 会话，且无需 checkout。 - **`move_node`**: 移动节点，包括重命名页面的路径。 - **`delete_node`**: 从导航中移除节点。可接受 `private-page-` 或 `private-folder-` 节点 ID，用于从调用者的私有树中删除[私有页面](/zh/editor/pages#private-pages)或私有文件夹。私有删除需要在该节点上具有 manager 角色的 OAuth 会话，且无需 checkout。 @@ -228,7 +230,7 @@ keywords: ["MCP", "写入权限", "AI", "编辑", "Claude", "ChatGPT", "Cursor", - 每次 `checkout` 都会返回一个 `editorUrl`。在单独的标签页中打开它，这样你就可以在提示时实时观察 AI 的更改在控制台编辑器中渲染。 + `checkout` 会返回 branch 的 `editorUrl`。`create_node` 和 `save` 会返回已更改页面的 `editorUrl`。在单独的标签页中打开这些链接，这样你就可以在提示时实时观察 AI 的更改在控制台编辑器中渲染。