Saltar al contenido principal
El Admin MCP expone las siguientes herramientas. Las herramientas de IA eligen qué herramientas llamar según tu prompt. Para ver cómo encajan las herramientas de edición y publicación, consulta Editar y publicar con el Admin MCP.

Contenido

  • read: Obtén el MDX completo de cualquier página en branch, o en tu rama de despliegue cuando lo omites. Pasa una ruta de página, como guides/setup, o el último segmento de una URL del editor, que es el ID de la página con un título opcional delante. Cuando uses un ID de página de una URL del editor, pasa la rama de esa URL como branch. La respuesta incluye un filePath que puedes pasar como path a edit_page y write_page, y una version del contenido que devolvió. Pasa forEdit: true para leer la página en vivo en lugar de su copia guardada. Usa forEdit: true antes de sobrescribir la página con write_page. Para leer una página privada, pasa su ID de nodo private-page-<uuid> obtenido de list_nodes con visibility: "private". Las lecturas privadas no necesitan branch 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: Busca en las páginas de branch por significado y por texto exacto, o en tu rama de despliegue cuando lo omites. Pasa una pregunta, un tema, un nombre o una frase exacta como query. De forma predeterminada, search devuelve primero las páginas más relevantes como results. Cada resultado incluye la path y el title de la página, y snippets con las líneas coincidentes. Cuando search confía en el primer resultado, ese resultado también incluye el content completo de la página, hasta 16 KB. Los siguientes resultados incluyen la section alrededor de su mejor coincidencia. Pasa limit para devolver hasta 20 páginas (6 por defecto). Para listar todas las páginas que contienen una frase, por ejemplo antes de un cambio de nombre, pasa mode: "all" (limit por defecto de 100, máximo 500). Pasar regex: true trata query como una expresión regular y siempre usa mode: "all".
  • edit_page: Aplica una edición dirigida a una página. Pasa path en los mismos formatos que en read. Pasa oldString y newString para un solo reemplazo, o pasa una lista edits de hasta 100 reemplazos para cambiar varias partes de una página en una sola llamada. Mintlify aplica las ediciones en orden, cada una sobre el resultado de la anterior. Si alguna edición falla, no se aplica ninguna. Al igual que write_page, edit_page devuelve notRendered para el marcado que añade la edición y que el editor descarta. No informa del marcado que ya estaba en la 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 no necesitan branch.
  • write_page: Sobrescribe el contenido MDX completo de una página. Pasa path en los mismos formatos que en read. Antes de sobrescribir una página, llama a read con forEdit: true y pasa la version devuelta a write_page como baseVersion. Si la página cambió desde esa lectura, Mintlify rechaza la escritura, no cambia nada y devuelve page_changed. Vuelve a leer la página y aplica de nuevo tu cambio. Si omites baseVersion en una página que tiene contenido, write_page devuelve base_version_required. Una página que solo tiene frontmatter no necesita baseVersion. También 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. Si el contenido incluye marcado que el editor de Mintlify descarta, como etiquetas <script>, bloques <style>, controladores de eventos como onClick o expresiones de JavaScript, la respuesta incluye un campo notRendered. Cada entrada indica el element descartado, su line, why el editor lo descarta y qué usar instead, como clases de Tailwind, objetos style={{}} en línea con valores literales o componentes de Mintlify como acordeones y pestañas.
  • read_page_history: Enumera el historial de versiones guardado de una página en branch, o en tu rama de despliegue cuando lo omites. Pasa path en los mismos formatos que en read, incluido un ID de nodo private-page-<uuid>. Devuelve versions, de la más reciente a la más antigua, y un nextCursor. Cada versión tiene un versionId, createdAt y authors, cada uno con un name y un type de user, git o system. Pasa limit para devolver de 1 a 50 versiones por llamada (20 por defecto), y vuelve a pasar nextCursor como cursor para enumerar versiones más antiguas. Pasa un versionId para obtener el MDX completo de esa versión como content. La herramienta es de solo lectura. Para restaurar una versión anterior, llama a read en la página con forEdit: true y luego pasa el content de la versión anterior a write_page con la version de esa lectura como baseVersion. Si esa versión contiene datos en línea que ya no están en la página, write_page no puede restaurarlos. En su lugar, restaura esa versión desde el historial de versiones en el editor. Los errores incluyen page_not_found, version_not_found e invalid_cursor.

Datos en línea

Las páginas pueden incrustar imágenes y otros archivos como URL de datos en base64. Para mantener las respuestas pequeñas, read, search, diff, read_page_history y read_comments reemplazan cada carga útil en base64 de 1000 caracteres o más por un marcador de posición como [elided 48210 chars #1234567890]. Mantén estos marcadores de posición sin cambios cuando vuelvas a pasar el contenido. edit_page, write_page, create_node y suggest_edit reemplazan cada marcador de posición por los datos originales del contenido actual de la página de destino. Si un marcador de posición no coincide con datos de la página de destino, Mintlify rechaza la escritura, no cambia nada y devuelve inline_data_unresolved. Copia los marcadores de posición solo de un read de la misma página. Si Mintlify no puede leer la página para restaurar los marcadores de posición, devuelve inline_data_source_unreadable y no cambia nada. Vuelve a intentar la llamada.

Cargas

  • upload_file: Inicia la carga de un archivo local. Pasa la path de destino, 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_file_upload: Guarda una imagen cargada en branch. 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_file, la herramienta de IA sube los bytes del archivo a uploadUrl con una solicitud PUT y los encabezados devueltos. Por ejemplo:
Para añadir una imagen, pasa una path de imagen, como images/dashboard.png, y la branch a upload_file. Después de la carga, llama a finalize_file_upload. 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. Solo las cargas de logotipos y favicons pueden ser archivos SVG: pasa purpose: "logo" a ambas herramientas cuando subas uno. Las imágenes de las páginas no pueden ser SVG. Las imágenes guardadas aparecen en status y se publican con el resto de tus ediciones cuando llamas a publish. Para escribir una página a partir de un archivo Markdown local, pasa una path .md o .mdx con contentType establecido en text/markdown o text/plain. Las cargas de páginas no necesitan branch ni finalize_file_upload. Después de la carga, pasa el uploadId en lugar de content a write_page, o como data.uploadId a create_node. Así evitas reenviar el contenido completo de una página grande en la llamada a la herramienta. Usa el uploadId en un plazo de 10 minutos. Cada uploadId funciona una sola vez, en el mismo proyecto y para el mismo usuario o cliente que lo creó. Mintlify elimina el archivo cargado después de la escritura. Un uploadId reutilizado o caducado devuelve upload_not_found.

Comentarios

Trabaja con los comentarios y sugerencias que tu equipo deja en el editor del panel.
  • read_comments: Lista los hilos de comentarios y sugerencias abiertos en una página, del más antiguo al más reciente. Pasa path en los mismos formatos que read. Cada hilo incluye un threadId, su type (comment o suggestion), el quotedText al que está anclado, el suggestedText de las sugerencias y sus comments con el author, el content y el createdAt de cada uno. Si el texto anclado ya no existe en la página, el hilo incluye anchorRemoved: true y quotedText muestra la cita original. Lee los hilos de branch, o de tu rama de despliegue cuando lo omites.
  • add_comment: Inicia un nuevo hilo de comentarios en una página sin cambiar su contenido. Úsalo para dejar comentarios a tu equipo en lugar de editar. Pasa path en los mismos formatos que read, el content del comentario y quotedText: el fragmento de texto visible único más corto al que anclarlo, dentro de un párrafo o encabezado. Usa las palabras renderizadas, no la sintaxis de Markdown o MDX. Por ejemplo, cita custom domain, no [custom domain](/path). Devuelve el nuevo threadId. Si el texto no está en la página, el error es no_match. Si coincide más de una vez, el error es not_unique, así que cita un fragmento más largo.
  • suggest_edit: Propone una sugerencia con control de cambios en una página en lugar de editarla. El texto original permanece en la página tachado y el reemplazo aparece a su lado. Nada cambia hasta que alguien acepta o rechaza la sugerencia en el editor del panel. Pasa path en los mismos formatos que read, oldString y newString. oldString es el fragmento de texto visible único más corto que se va a reemplazar, dentro de un párrafo o encabezado. Usa las palabras renderizadas, no la sintaxis de Markdown o MDX. Pasa un newString vacío para sugerir una eliminación. Pasa un comment opcional para explicar por qué el cambio es útil. Mintlify lo publica como la respuesta del agente en el hilo de la sugerencia. El parámetro anterior note sigue funcionando como alias obsoleto de comment. Devuelve el nuevo threadId con originalText y suggestedText, recortados al fragmento que cambia. Si la misma sugerencia ya está abierta, la respuesta incluye alreadyExists: true y el threadId existente. Los errores no_match y not_unique funcionan igual que en add_comment. El error es no_change cuando ambas cadenas son iguales y conflicting_annotation cuando el texto se superpone con otra sugerencia abierta.
  • reply_to_comment: Responde a un hilo por threadId con content. Pasa resolve: true para resolver también el hilo. Mintlify publica la respuesta como el agente en nombre del usuario que autorizó la conexión, y aparece en tiempo real en el editor del panel.
  • resolve_comment: Resuelve un hilo sin responder.
  • read_inbox: Lista tu bandeja de entrada del dashboard en un proyecto, con la actividad más reciente primero. La bandeja de entrada incluye comentarios y menciones, ediciones sugeridas, solicitudes de revisión, y páginas y carpetas privadas compartidas contigo. De forma predeterminada, read_inbox devuelve los elementos abiertos. Pasa state como open, done o all, y section como comment, suggestion, invitation, request o all (predeterminado). La sección request incluye solicitudes de revisión e invitaciones. Pasa filter para limitar los comentarios a mentions u on-my-page (páginas de las que eres propietario), las sugerencias a las de people o del agent, o la sección request a requests o invites. El filtro debe coincidir con section, a menos que section sea all. Pasa dateFrom y dateTo como fechas y horas ISO 8601 para limitar los elementos según su actividad más reciente. Pasa limit para obtener de 1 a 50 elementos por llamada (20 de forma predeterminada), y pasa nextCursor como cursor para listar elementos más antiguos. Cada elemento incluye su category, state, latestActivity y target. Cuando target.thread está presente, no está resuelto y no está en una página privada, llama a read_comments con su filePath y responde con reply_to_comment, ambos en su branch. Los elementos restricted no incluyen detalles del hilo. read_inbox es de solo lectura y nunca marca elementos como leídos o completados. Los errores incluyen invalid_filter, invalid_date_range e invalid_cursor.
add_comment, suggest_edit, reply_to_comment y resolve_comment requieren una sesión OAuth y una branch. Actúan sobre los hilos de esa rama y funcionan en tu rama de despliegue incluso cuando sus ediciones requieren una pull request. Puedes responder a hilos de sugerencias, pero debes aceptar o rechazar las sugerencias en el editor. Los comentarios en páginas privadas no están disponibles a través del Admin MCP. read_inbox también requiere una sesión OAuth y solo devuelve la bandeja de entrada de un miembro activo de la organización del proyecto.
  • list_nodes: Recorre el árbol de navegación de branch, o de tu rama de despliegue cuando lo omites, 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 archivos y carpetas subidos (nodos file y file_directory) solo aparecen cuando los incluyes en el filtro de tipo. Cada nodo devuelve su id, type, text y parent, además de path, pageId y hidden cuando corresponda. Pasa el path de una página a read para obtener su contenido y su frontmatter. 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 ignora branch y 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, no necesita branch 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. Si ya existe una página en la path de branch, create_node escribe el nuevo contenido en esa página en lugar de fallar. La página conserva su lugar en la navegación, aunque pases un padre diferente, y la respuesta incluye updated: true. Si Mintlify agrega una página nueva a la navegación pero no puede guardar su contenido, create_node devuelve PAGE_SEED_FAILED. Llama de nuevo a create_node con la misma path para escribir el contenido.
  • 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 no necesitan branch.
  • 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 no necesitan branch.
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 publish.

Configuración

  • update_config: Cambia los ajustes de nivel superior de docs.json, como el tema, los colores, el logotipo, la barra de navegación, el pie de página, las redirecciones, las integraciones y el SEO. No puede cambiar navigation; usa las herramientas de navegación en su lugar. Mintlify rechaza por completo una configuración no válida.

Skill de Mintlify

  • read_skill: Lee la guía de Mintlify para escribir documentación, que abarca páginas, componentes, widgets, navegación y docs.json. Es la misma skill de Mintlify que usa el agente. Llámala sin path para obtener SKILL.md, el índice de la skill, y una lista files con sus archivos de referencia. Pasa un archivo de esa lista como path, como reference/widgets.md, para leerlo. La herramienta es de solo lectura y no necesita subdomain ni branch. Si el archivo no existe, devuelve skill_file_not_found con la lista files.
La respuesta del índice también incluye una lista skills con las skills del agente de tu organización y las tuyas que estén activadas, cada una con name, description y path. Pasa el path de una skill, como org/release-notes/SKILL.md, para leer sus instrucciones. La respuesta enumera los archivos de referencia de la skill en files, y puedes pasar cualquiera de ellos como path. Las rutas de las skills personales empiezan por me/ y solo aparecen en sesiones OAuth. El Admin MCP indica a las herramientas de IA que llamen a read_skill antes de escribir, reestructurar o dar estilo a las páginas, y que sigan cualquier skill de la organización o personal cuya descripción se ajuste a la tarea.

Gestión de proyectos

Las herramientas de gestión de proyectos gestionan las operaciones a nivel de proyecto, como administrar automatizaciones, 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. Actúan sobre el proyecto en vivo, no sobre una rama. 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, incluidos los ajustes de publicación del editor y de Revisión, 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_analytics_schema: Lee las tablas, los eventos y las reglas de SQL que acepta query_analytics. La herramienta de IA lo llama una vez antes de escribir una consulta.
  • query_analytics: Ejecuta una consulta SELECT de solo lectura sobre las analíticas de tu sitio, como vistas de página, búsqueda, asistente, feedback y tráfico. Los resultados ya están limitados al proyecto. Si las consultas de analíticas no están habilitadas para el proyecto, ambas herramientas de consulta de analíticas devuelven un error not_enabled.
  • get_workflows: Lista las automatizaciones, obtiene una 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 una automatización.
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 editor_publishing para cambiar los ajustes de Revisión. Solo los administradores de la organización pueden cambiarlos, con las mismas reglas que en el dashboard. 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. El cambio solo conserva una configuración JWT. Si la configuración activa usa cualquier otro tipo, el cambio falla con un error 409 y deja tu sitio sin cambios. Para cambiar a un tipo diferente, configura la nueva autenticación directamente. Cuando una acción activa la autenticación del sitio, incluido un cambio desde la autenticación de usuarios finales, Mintlify elimina las vistas previas existentes que no tienen inicio de sesión de la organización ni protección con contraseña. Establece previewDeployments en delete_unauthenticated (predeterminado), delete_all o keep para elegir qué sucede con las vistas previas existentes.
  • manage_workflow: Crea, actualiza, habilita o deshabilita, elimina o ejecuta una automatización. En un proyecto con varios repositorios, pasa un repo_name opcional (por ejemplo, mintlify/docs) al crear o actualizar una automatización para establecer su repositorio de destino. El repositorio debe estar conectado al proyecto. Si lo omites, las automatizaciones nuevas usan la fuente base y las actualizaciones mantienen el destino actual.
  • manage_workflow_prs: Fusiona o cierra una pull request abierta por una ejecución de automatización. Para fusionar una pull request de una rama que editó la herramienta de IA, usa publish con merge: true en su lugar.
  • manage_members_sharing: Lista, invita o elimina miembros de la organización, actualiza sus roles o gestiona los permisos y traslados de páginas privadas en bases. Una sola llamada invita hasta 250 personas y omite a quien ya sea miembro o tenga una invitación pendiente.
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. Para solucionarlo, consulta Las llamadas a herramientas devuelven 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 automatizaciones, configuraciones, dominios, autenticación o miembros.

Solicitudes de revisión

Estas herramientas solo aparecen cuando tu proyecto requiere revisión antes de publicar. list_review_requests y request_review aceptan un branch opcional, que de forma predeterminada es tu rama de despliegue. En otra rama, una solicitud de revisión cubre los cambios de la rama respecto a tu rama de despliegue. Si tu rama de despliegue tiene protección de rama de GitHub, solicita revisiones en una rama de funcionalidad.
  • list_review_requests: Lista las solicitudes de revisión abiertas en una rama. Cada solicitud incluye su requester, sus reviewers y su state, y sus pages. Cada página tiene un path, un title y una approval con el valor approved, pending o stale si la página cambió después de la aprobación y necesita otra revisión. Los cambios que no pertenecen a una página, como la navegación y la configuración del sitio, aparecen como un único elemento titulado Site changes.
  • request_review: Pide a los revisores que aprueben tus cambios pendientes. Pasa hasta 100 pages en los mismos formatos que read, y los reviewers, cada uno como email o role. role: "admin" lo pide a todos los administradores. role: "editor" lo pide a todos los publicadores, o a todos los editores si tu organización no tiene el rol de publicador. Si tienes cambios pendientes que no pertenecen a una página y ninguna otra solicitud abierta los incluye, Mintlify agrega el elemento Site changes a la solicitud. Mintlify solo lo pide a miembros activos, distintos de ti, que puedan aprobar. Cada revisor recibe un correo electrónico y un elemento en la bandeja de entrada. Los errores incluyen no_pending_changes cuando una página no tiene nada que revisar, no_reviewers cuando nadie que pueda aprobar coincide con reviewers y review_unavailable cuando la rama no admite solicitudes de revisión, como una rama de despliegue protegida.
  • add_reviewers: Agrega revisores a una solicitud de revisión abierta mediante requestId, sin retirarla, como al agregar revisores en el editor. Pasa reviewers en los mismos formatos que en request_review. Las aprobaciones existentes se mantienen. Mintlify omite al solicitante, a las personas que ya están en la solicitud y a los miembros que no pueden aprobar, y solo los revisores nuevos reciben un correo electrónico y un elemento en la bandeja de entrada. Devuelve la request actualizada y los correos electrónicos added. Los errores incluyen request_not_found y no_reviewers.
  • withdraw_review_request: Retira una solicitud de revisión que hiciste mediante requestId. Pasa un reviewer con un correo electrónico para quitar solo a ese revisor. Quitar al último revisor retira la solicitud. Las páginas conservan sus cambios pendientes.
  • approve_review_request: Aprueba la solicitud de revisión de otra persona mediante requestId, como al hacer clic en Approve en el editor. El Admin MCP indica a la herramienta de IA que solo apruebe cuando le pidas aprobar esa solicitud concreta, y que primero confirme contigo el solicitante y las páginas. Devuelve own_request para tu propia solicitud, own_branch para una rama que creaste, not_reviewer si tu rol no puede aprobar, changed si los cambios se editaron después de que la herramienta de IA los leyera y github_rejected si GitHub rechazó la aprobación, por ejemplo porque no has conectado tu cuenta de GitHub. En una rama protegida de GitHub, aprobar también aprueba la pull request en GitHub con tu cuenta conectada.
  • publish_review_request: Publica una solicitud de revisión aprobada mediante requestId, con un title para el mensaje de commit, como al publicar los cambios aprobados de un compañero en el editor. Los administradores y publicadores pueden publicar. El Admin MCP indica a la herramienta de IA que solo publique cuando le pidas publicar esa solicitud concreta. Devuelve not_approved hasta que cada página tenga las aprobaciones que necesita, navigation_held mientras otra solicitud abierta retiene cambios de navegación que esta solicitud necesita y not_allowed si tu rol no puede publicar. En una rama de funcionalidad, fusiona la pull request de la rama en tu rama de despliegue y devuelve merged. Devuelve no_pull_request si la rama aún no tiene pull request, así que llama primero a publish en la rama, y merge_not_allowed si debes fusionar en el editor. Sigue el deployment devuelto con deployment_status.

Ramas y publicación

  • list_deployments: Lista los proyectos a los que tu conexión puede acceder, devolviendo cada {subdomain, name, projectType}. projectType es site para un sitio o workspace para una base de conocimiento. Llama a esto para descubrir qué subdomain pasar.
  • create_branch: Crea una nueva rama a partir de tu rama de despliegue, o de la rama existente que pases como from, con un title que también nombra su pull request. Devuelve el branchName que debes pasar como branch. Consulta Trabajar en una rama. No lo necesitas para editar la rama de despliegue 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. Pasa cualquiera de ellas como branch.
  • status: Lista los archivos editados, las claves de docs.json modificadas y el diff de navegación pendiente en branch, o en tu rama de despliegue cuando lo omites. En la rama de despliegue, lista solo tus cambios.
  • diff: Lista todos los cambios entre branch 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.
  • publish: En la rama de despliegue, hace commit directamente solo de tus cambios pendientes. Si tu proyecto requiere revisión y no eres administrador, devuelve review_required en la rama de despliegue o cuando pasas merge: true. Consulta Proyectos que requieren revisión. En una rama, hace commit de los cambios pendientes y devuelve la pull request de la rama, y abre una si es necesario. Pasa merge: true para fusionar también la pull request cuando se permiten ediciones en la rama de despliegue. Cuando los cambios llegan a la rama de despliegue, también devuelve un estado deployment que puedes seguir con deployment_status.
  • deployment_status: Comprueba si los cambios publicados ya están activos en tu sitio de documentación. Pasa el commitSha de publish, u omítelo para comprobar el despliegue más reciente. Devuelve un state con el valor pending, queued, building, live, not_live, failed o skipped, junto con live y un message para compartir contigo. not_live significa que el sitio aún sirve una versión anterior, por ejemplo porque el despliegue se revirtió o tu despliegue está fijado a una versión anterior.
  • discard: Abandona las ediciones en branch. En la rama de despliegue, revierte solo tus cambios pendientes. En otra rama que creaste, elimina la rama y cierra su pull request.