Saltar al contenido principal

Acerca del Admin MCP

El servidor Admin MCP otorga a las herramientas de IA acceso de escritura a tu contenido y configuración de Mintlify. Úsalo para actualizar contenido y acceder a tu panel. Con el Admin MCP, puedes usar tus herramientas de IA preferidas para editar páginas, reestructurar la navegación, actualizar docs.json, abrir pull requests, cambiar configuraciones, crear workflows y más. Conecta cualquier cliente MCP como Claude, Claude Code, ChatGPT o Cursor al servidor Admin MCP. Úsalo para colaborar en tu contenido y configuración de Mintlify con las mismas herramientas que usas para escribir código. Las ediciones de contenido ocurren en una rama y se publican mediante una pull request o un commit cuando llamas a save. Los cambios de gestión de proyectos, como las actualizaciones de workflows y de configuración, se aplican de inmediato al proyecto en vivo. Si tu organización tiene varios proyectos, una sola conexión de Admin MCP puede acceder a todos ellos y alternar entre ellos.
El servidor Admin MCP permite que las herramientas de IA accedan a tu panel de Mintlify. Trátalo como una herramienta con acceso de escritura. Conéctalo solo desde herramientas de IA de confianza, revisa cada pull request antes de fusionarla y ten en cuenta que los cambios de gestión de proyectos se aplican de inmediato sin una pull request.
El Admin MCP es un servicio alojado por Mintlify en https://mcp.mintlify.com. Todos los clientes se conectan al mismo endpoint y se autentican con tu cuenta de Mintlify.

Cómo se diferencia el Admin MCP de otros servidores MCP de Mintlify

Consulta la referencia del MCP de Mintlify Index para ver sus entradas de herramientas y límites de uso.

Requisitos previos

Antes de conectar el Admin MCP, confirma lo siguiente:
  • Cuenta de Mintlify: Necesitas una cuenta de Mintlify con acceso al proyecto que quieres editar. La sesión de OAuth hereda tus permisos del panel, por lo que las acciones exclusivas de administrador (como update_config en configuraciones protegidas) requieren un rol de administrador en el proyecto.
  • Acceso al proveedor de Git: La conexión de GitHub, GitLab o Bitbucket del proyecto debe tener acceso de escritura al repositorio de la rama de despliegue. save abre PRs a través de la misma integración utilizada para los despliegues normales.
  • Cliente MCP: Una herramienta de IA compatible con MCP, como Claude, Claude Code, ChatGPT, Cursor o Codex.

Conectarse al Admin MCP

Debes tener un inicio de sesión OAuth interactivo en tu cuenta de Mintlify para conectarte al Admin MCP. Las herramientas de IA intercambian ese inicio de sesión por un token de sesión limitado a uno o varios proyectos, según cómo otorgues el acceso. Una conexión limitada a proyectos específicos solo puede hacer checkout de esos proyectos. Una conexión a nivel de organización puede hacer checkout de cualquier proyecto de tu organización.
1

Agregar el Admin MCP como conector personalizado

  1. Navega a la página Connectors en la configuración de Claude.
  2. Haz clic en Add custom connector.
  3. Agrega el conector:
    • Nombre: Admin MCP
    • URL: https://mcp.mintlify.com
  4. Haz clic en Add y completa el inicio de sesión OAuth.
2

Usar el MCP en un chat

Haz clic en el botón de archivos adjuntos (el icono más) y luego selecciona tu servidor Admin MCP. Claude ahora puede llamar a las herramientas del Mintlify Admin MCP mientras responde a tu prompt.

Cómo funciona una sesión

Cada sesión del Admin MCP se vincula a una sola rama de Git. El flujo es:
1

Descubrir proyectos (opcional)

Si tu conexión tiene acceso a más de un proyecto, llama a list_deployments para ver qué valores de subdomain puedes usar en checkout. Omite este paso si tu conexión cubre solo un proyecto.
2

Hacer checkout de una rama

La primera llamada requerida es checkout {subdomain}. Crea una nueva rama admin-mcp/<slug>-<sha> a partir de la rama de despliegue de ese proyecto (o se adjunta a una rama existente que indiques). También devuelve un editorUrl que puedes abrir para seguir el progreso en el editor del panel.Para omitir la rama de sesión y editar directamente tu rama de despliegue, pásala como branch. Consulta Editar la rama de despliegue directamente.Llama a list_branches antes de checkout si necesitas descubrir o filtrar las ramas existentes en el repositorio de un proyecto.
3

Leer, buscar y editar

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.
4

Revisar el diff

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.
5

Guardar

Llama a save para enviar la rama a Git. mode: "auto" (predeterminado) abre una pull request. Si la configuración de revisión del agente del proyecto es push-to-main y la rama de despliegue no está protegida, Mintlify fusiona la pull request de inmediato (la respuesta incluye merged: true). Usa mode: "pr" para abrir siempre una pull request y dejarla abierta para revisión. Usa 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.
6

Descartar si es necesario

Llama a discard_session para descartar todos los cambios en la sesión y liberar la rama.
Si tu conexión tiene acceso a varios proyectos, cada proyecto del que hagas checkout mantiene su propia sesión y rama en memoria al mismo tiempo.Llamar a checkout de nuevo con un subdomain o una rama distinta cambia qué sesión está activa. No descarta las demás. Para abandonar un borrador en curso en lugar de simplemente alejarte de él, llama a discard_session.

Editar la rama de despliegue directamente

Pasa tu rama de despliegue a checkout para editarla igual que en el editor del panel. Por ejemplo, checkout { subdomain: "acme", branch: "main" }. Mintlify vincula la sesión a la rama de despliegue en lugar de crear una rama admin-mcp/*. El checkout es más rápido y no se crea ninguna pull request. La herramienta de IA actúa en tu nombre en la rama de despliegue:
  • Las ediciones son visibles en vivo para los colaboradores. Cualquier otra persona que edite la rama de despliegue en el panel ve los cambios de la IA a medida que ocurren.
  • save publica solo tus cambios. Ignora mode y hace commit de tus cambios pendientes directamente en la rama de despliegue, como al hacer clic en Publish en el editor. Los cambios no publicados de otras personas siguen pendientes. Tus propias ediciones no publicadas del editor del panel también se publican.
  • discard_session revierte solo tus cambios. Devuelve discardedChanges con el número de cambios revertidos. Los cambios de otras personas y la propia rama no se modifican.
  • get_session_state lista solo tus cambios.
Mintlify registra los cambios por página. Si tú y otra persona editaron la misma página, save publica la página completa y discard_session revierte la página completa, incluidas las ediciones de la otra persona. Cuando se cumple alguna de estas condiciones, Mintlify crea en su lugar una rama de sesión a partir de la rama de despliegue. checkout devuelve una note que explica el motivo:
  • La protección de tu rama de despliegue exige pull requests, o Mintlify no puede comprobar tus reglas de protección de ramas.
  • La edición de la rama de despliegue está bloqueada en el editor del panel.
  • Enviar directamente a tu rama de despliegue está desactivado en tu configuración de publicación.
  • Te conectaste con un token de cliente o de máquina a máquina en lugar de un inicio de sesión OAuth. Estos tokens no están vinculados a un usuario, así que no tienen cambios “propios”.

Publicación

La sección Publicación en la página de configuración del Admin MCP de tu panel controla qué ocurre cuando save se ejecuta con mode: "auto". Activa Enviar directamente a tu rama de despliegue para que Mintlify envíe los cambios directamente a tu rama de despliegue. Desactívalo para que save abra una pull request en su lugar. Este interruptor comparte el mismo ajuste agentReviewProcess que los agentes de Slack y del panel, por lo que cualquier cambio aquí también se aplica a esos flujos. El interruptor se deshabilita en tres casos:
  • Tu rama de despliegue requiere una pull request. Si las reglas de protección de rama o las aprobaciones requeridas impiden los push directos, los cambios del MCP siempre abren una pull request, independientemente de este ajuste.
  • Mintlify aloja tu proyecto. Para los sitios alojados por Mintlify, los cambios del MCP siempre se envían directamente, a menos que la protección de rama aún requiera una pull request.
  • No eres administrador. Cambiar este ajuste requiere el rol de administrador en tu proyecto. Los editores y lectores ven el interruptor deshabilitado con un banner de permisos.
También puedes anular el ajuste caso por caso pasando un mode explícito a save. Establece "pr" para abrir siempre una pull request, o "commit" para hacer push a una rama de PR existente sin abrir una nueva PR.

Qué puede hacer el Admin MCP

Contenido

  • read: Obtén el MDX completo de cualquier página en la rama de la sesión. Pasa una ruta de página como /quickstart, o el ID de página de una URL del editor (el segmento después de ~/), para que una herramienta de IA pueda abrir una página directamente desde un enlace del editor. Para leer una página privada, pasa su ID de nodo private-page-<uuid> obtenido de list_nodes con visibility: "private". Las lecturas privadas funcionan sin un checkout y requieren una sesión OAuth. El Admin MCP rechaza los tokens de cliente y de máquina a máquina para el acceso a páginas privadas.
  • search: Encuentra líneas que coincidan con una subcadena o expresión regular en todas las páginas.
  • edit_page: Aplica una edición dirigida a una página. Para editar una página privada, pasa su ID de nodo private-page-<uuid> como path. Las ediciones privadas requieren una sesión OAuth con rol de editor o superior en la página y funcionan sin un checkout.
  • write_page: Sobrescribe el contenido MDX completo de una página. Acepta un ID de nodo private-page-<uuid> para sobrescribir una página privada bajo los mismos requisitos de OAuth y rol que edit_page. Usa create_node para crear una nueva página privada.

Imágenes

  • upload_image: Inicia la carga de un archivo de imagen local a la rama de la sesión. Pasa la path de destino (por ejemplo, images/dashboard.png), el contentType del archivo y su size exacto en bytes. Devuelve un uploadId, una uploadUrl prefirmada y los headers que debes enviar con la carga.
  • finalize_image_upload: Guarda la imagen cargada en la rama de la sesión. Pasa el uploadId y la misma path. Devuelve el src que debes referenciar en MDX con edit_page o write_page, o en los campos logo o favicon de docs.json con update_config.
Después de upload_image, la herramienta de IA sube los bytes del archivo a uploadUrl con una solicitud PUT y los encabezados devueltos. Por ejemplo:
Mintlify comprueba que el contenido del archivo cargado coincida con su extensión antes de guardarlo. Una carga a una path existente reemplaza esa imagen. Mintlify solo acepta archivos SVG para logotipos y favicons, así que pasa purpose: "logo" a ambas herramientas cuando subas uno. Las imágenes guardadas aparecen en get_session_state y se publican con el resto de la sesión cuando llamas a save.
  • 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 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 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-<uuid> existente. Para las páginas nuevas, la respuesta incluye un editorUrl que abre la página en tu 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-<uuid> o private-folder-<uuid> para renombrar una página privada 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-<uuid> o private-folder-<uuid> para eliminar una página privada 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.

Configuración

  • update_config: Modifica docs.json (tema, raíces de navegación, integraciones, configuración de SEO).

Gestión de proyectos

Las herramientas de gestión de proyectos gestionan las operaciones a nivel de proyecto, como administrar workflows, la configuración del proyecto, los dominios personalizados, las fuentes de Git, la autenticación, los miembros, las analíticas y el uso compartido de páginas privadas. No requieren un checkout. Cada herramienta recibe un subdomain del proyecto sobre el que actuar. Las conexiones de toda la organización deben pasar subdomain. Llama a list_deployments para encontrarlo. Las herramientas de lectura también aceptan subdomains, una lista de hasta 25 proyectos, y devuelven un resultado o un error para cada uno. La mayoría de las herramientas reciben un objeto request cuyo campo action selecciona la operación. Por ejemplo:
Herramientas de lectura:
  • get_deployment_settings: Lee la configuración del dashboard de un proyecto, sus fuentes de Git, el estado de sus hostnames personalizados y sus comprobaciones de fuentes en una sola llamada. La configuración de Slack y los snippets son opcionales.
  • get_analytics_report: Lee un informe de analíticas predefinido, como vistas de página, páginas populares, referencias, feedback, chats del asistente o calidad de búsqueda. Selecciona el informe con request.report. Los resultados grandes se paginan con maxRows y rowOffset. Para consultas personalizadas, usa query_analytics.
  • get_workflows: Lista los workflows, obtiene uno o recorre sus ejecuciones.
  • list_repos_and_prs: Lista los repositorios conectados, las pull requests de un repositorio o las integraciones disponibles para usar en un workflow.
Herramientas de escritura:
  • update_deployment_settings: Cambia un ajuste del dashboard, como noindex, base_path, name, disable_ai_chat, search_settings, privacy, custom_scripts o un complemento. Usa update_config para los ajustes de docs.json.
  • manage_custom_domain: Agrega o elimina un dominio personalizado, aprovisiona su hostname o vuelve a lanzar la validación del hostname.
  • manage_git_source: Agrega, actualiza, elimina o reordena los repositorios de Git desde los que se compila un proyecto, o establece la fuente base.
  • manage_access_auth: Configura o elimina la autenticación del sitio, agrega o elimina contraseñas, configura la autenticación de usuarios finales o cambia cuál está activa.
  • manage_workflow: Crea, actualiza, habilita o deshabilita, elimina o ejecuta un workflow.
  • manage_members_sharing: Lista o elimina miembros de la organización, actualiza sus roles o gestiona los permisos y traslados de páginas privadas.
Las herramientas de escritura devuelven el estado actualizado del proyecto en state, para que la herramienta de IA pueda confirmar el cambio sin una segunda llamada. Cada acción comprueba los ámbitos otorgados a la conexión y tu rol en el dashboard. Una acción para la que no tienes autorización devuelve un error como insufficient_scope.
Las escrituras de gestión de proyectos se aplican de inmediato al proyecto en vivo. No crean una rama ni abren una pull request. Confirma el cambio previsto antes de pedirle a una herramienta de IA que actualice workflows, configuraciones, dominios, autenticación o miembros.

Sesión

  • list_deployments: Lista los proyectos a los que tu conexión puede acceder, devolviendo cada {subdomain, name}. Llama a esto para descubrir qué subdomain pasar a checkout.
  • checkout: Vincula una sesión a una rama para un subdomain de proyecto dado, o cambia qué sesión de proyecto está activa. Pasa la rama de despliegue como branch para editarla directamente.
  • list_branches: Lista las ramas de Git disponibles para el repositorio de un proyecto, con filtrado opcional por query. Devuelve los nombres de las ramas, el total y la rama de despliegue. Llama a esto antes de checkout para adjuntarte a una rama existente por nombre.
  • get_session_state: Inspecciona la rama actual, los archivos editados y el diff de navegación pendiente. En la rama de despliegue, lista solo tus cambios.
  • diff: Lista todos los cambios entre la sesión y tu rama de despliegue. Cada archivo modificado y la entrada de docs.json incluyen authors y byYou. authors enumera los miembros cuyas ediciones no publicadas contiene la entrada. byYou es true cuando la entrada incluye tus propias ediciones. Usa byYou para distinguir tus cambios de los de un colega en una rama compartida.
  • save: Abre una pull request o hace commit en la rama de la sesión. Mintlify fusiona automáticamente la PR cuando el proyecto está configurado para enviar los cambios del agente a main y la rama de despliegue no está protegida. En la rama de despliegue, hace commit directamente solo de tus cambios pendientes.
  • discard_session: Descarta la sesión y sus cambios pendientes. En la rama de despliegue, revierte solo tus cambios pendientes.

Ejemplos de prompts

Después de conectarte al Admin MCP, puedes manejarlo con prompts en lenguaje natural. Por ejemplo:
  • “Haz checkout de una rama llamada add-billing-faq y crea una nueva página bajo el grupo FAQ titulada ‘Billing’. Redacta respuestas para las cinco preguntas de este issue de Linear.”
  • “Encuentra todas las páginas que mencionen el campo obsoleto legacy_token y actualiza el ejemplo para que use api_key en su lugar. Guarda como PR titulada ‘docs: replace legacy_token references’.”
  • “Reorganiza la referencia de API: mueve las páginas de webhooks a un nuevo grupo llamado ‘Webhooks’ y actualiza los iconos para que coincidan con el resto de la sección.”

Buenas prácticas

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.
El Admin MCP es lo suficientemente potente como para reescribir cientos de páginas en una sola sesión. Antes de fusionar, lee el diff de la PR y revisa la vista previa renderizada. No apruebes cambios grandes sin revisarlos.
Pasa un slug a checkout (por ejemplo, add-quickstart) para que la rama generada automáticamente sea legible. Sin él, el nombre de la rama deriva del token de sesión y es difícil de reconocer en tu repositorio.
Mantén cada sesión enfocada en un solo cambio. Las sesiones más pequeñas producen pull requests más fáciles de revisar y preservan las ventanas de contexto de los agentes. Usa discard_session y vuelve a llamar a checkout para cambiar a un trabajo no relacionado.
Las sesiones mantienen una rama en memoria en el lado de Mintlify. Si abandonas una sesión sin guardarla ni descartarla, la rama persiste hasta que tu próximo checkout la sobrescriba. Evita dejar ramas admin-mcp/* obsoletas en tu repositorio. Límpialas periódicamente.

Desconectar o revocar el acceso

Desconecta el Admin MCP cuando ya no quieras que una herramienta de IA edite tu proyecto, o cuando quieras forzar un nuevo inicio de sesión de OAuth.
  • Revocar la autorización de OAuth: En tu panel de Mintlify, ve a Settings → Security & access → Connected apps y revoca la entrada de la herramienta de IA que conectaste. Revocar invalida el token de acceso de la herramienta en un plazo de 30 segundos. Después, las llamadas a herramientas fallan y la herramienta debe completar un nuevo inicio de sesión de OAuth en la próxima llamada.
  • Eliminar el conector en el cliente:
    • Claude: Settings → Connectors, luego elimina la entrada del Admin MCP.
    • Claude Code: claude mcp remove mintlify.
    • ChatGPT: Settings → Connectors, luego elimina la entrada de Mintlify.
    • Cursor: elimina la entrada mintlify de mcp.json y recarga.
    • Codex: elimina el bloque [mcp_servers.mintlify] de ~/.codex/config.toml.
Revocar la autorización de OAuth no afecta a las pull requests que el MCP ya haya abierto. Cierra o revierte esas PRs en tu proveedor de Git si quieres deshacer los cambios pendientes.