Passer au contenu principal
L’Admin MCP expose les outils suivants. Les outils d’IA choisissent les outils à appeler en fonction de votre prompt. Pour savoir comment les outils de modification et de publication s’articulent, consultez Modifier et publier avec l’Admin MCP.

Contenu

  • read: Récupère le MDX complet de n’importe quelle page sur branch, ou sur votre branche de déploiement lorsque vous l’omettez. Transmettez un chemin de page, comme guides/setup, ou le dernier segment d’une URL de l’éditeur, qui correspond à l’ID de la page éventuellement précédé d’un titre. Lorsque vous utilisez un ID de page issu d’une URL de l’éditeur, transmettez la branche de cette URL comme branch. La réponse inclut un filePath que vous pouvez transmettre comme path à edit_page et write_page, ainsi qu’une version du contenu renvoyé. Transmettez forEdit: true pour lire la page en direct plutôt que sa copie enregistrée. Utilisez forEdit: true avant de réécrire la page avec write_page. Pour lire une page privée, transmettez son ID de nœud private-page-<uuid> obtenu depuis list_nodes avec visibility: "private". Les lectures privées n’ont pas besoin de branch et nécessitent une session OAuth. L’Admin MCP refuse les jetons client et machine à machine pour l’accès aux pages privées.
  • search: Recherche dans les pages de branch par sens et par formulation exacte, ou dans votre branche de déploiement lorsque vous l’omettez. Passez une question, un sujet, un nom ou une expression exacte comme query. Par défaut, search renvoie d’abord les pages les plus pertinentes sous forme de results. Chaque résultat contient le path et le title de la page, ainsi que des snippets avec les lignes correspondantes. Lorsque search est confiant quant au premier résultat, celui-ci inclut aussi le content complet de la page, jusqu’à 16 Ko. Les résultats suivants incluent la section autour de leur meilleure correspondance. Passez limit pour renvoyer jusqu’à 20 pages (6 par défaut). Pour lister toutes les pages qui contiennent une expression, par exemple avant un renommage, passez mode: "all" (limit par défaut de 100, maximum 500). Passer regex: true traite query comme une expression régulière et utilise toujours mode: "all".
  • edit_page: Applique une modification ciblée à une page. Transmettez path sous les mêmes formes que pour read. Transmettez oldString et newString pour un seul remplacement, ou transmettez une liste edits de jusqu’à 100 remplacements pour modifier plusieurs parties d’une page en un seul appel. Mintlify applique les modifications dans l’ordre, chacune sur le résultat de la précédente. Si une modification échoue, aucune n’est appliquée. Comme write_page, edit_page renvoie notRendered pour le balisage ajouté par la modification que l’éditeur supprime. Il ne signale pas le balisage déjà présent sur la page. Pour modifier une page privée, transmettez son ID de nœud private-page-<uuid> comme path. Les modifications privées nécessitent une session OAuth avec un rôle d’editor ou supérieur sur la page et n’ont pas besoin de branch.
  • write_page: Réécrit le contenu MDX complet d’une page. Transmettez path sous les mêmes formes que pour read. Avant de réécrire une page, appelez read avec forEdit: true et transmettez la version renvoyée à write_page comme baseVersion. Si la page a changé depuis cette lecture, Mintlify refuse l’écriture, ne modifie rien et renvoie page_changed. Relisez la page et réappliquez votre modification. Si vous omettez baseVersion sur une page qui a du contenu, write_page renvoie base_version_required. Une page qui ne contient que du frontmatter n’a pas besoin de baseVersion. Accepte également un ID de nœud private-page-<uuid> pour réécrire une page privée avec les mêmes exigences OAuth et de rôle que edit_page. Utilisez create_node pour créer une nouvelle page privée. Si le contenu inclut du balisage que l’éditeur Mintlify supprime, comme des balises <script>, des blocs <style>, des gestionnaires d’événements comme onClick ou des expressions JavaScript, la réponse inclut un champ notRendered. Chaque entrée indique l’element supprimé, sa line, why l’éditeur le supprime et quoi utiliser instead, comme des classes Tailwind, des objets style={{}} en ligne avec des valeurs littérales ou des composants Mintlify comme les accordéons et les onglets.
  • read_page_history: Liste l’historique des versions enregistré d’une page sur branch, ou sur votre branche de déploiement lorsque vous l’omettez. Transmettez path sous les mêmes formes que pour read, y compris un ID de nœud private-page-<uuid>. Renvoie versions, de la plus récente à la plus ancienne, et un nextCursor. Chaque version possède un versionId, un createdAt et des authors, chacun avec un name et un type parmi user, git ou system. Transmettez limit pour renvoyer de 1 à 50 versions par appel (20 par défaut), et retransmettez nextCursor comme cursor pour lister les versions plus anciennes. Transmettez un versionId pour obtenir le MDX complet de cette version dans content. L’outil est en lecture seule. Pour restaurer une version antérieure, appelez read sur la page avec forEdit: true, puis transmettez le content de la version antérieure à write_page avec la version de cette lecture comme baseVersion. Si cette version contient des données intégrées qui ne sont plus sur la page, write_page ne peut pas les restaurer. Restaurez plutôt cette version depuis l’historique des versions dans l’éditeur. Les erreurs incluent page_not_found, version_not_found et invalid_cursor.

Données intégrées

Les pages peuvent intégrer des images et d’autres fichiers sous forme d’URL de données en base64. Pour que les réponses restent légères, read, search, diff, read_page_history et read_comments remplacent chaque contenu base64 de 1 000 caractères ou plus par un espace réservé tel que [elided 48210 chars #1234567890]. Conservez ces espaces réservés tels quels lorsque vous renvoyez le contenu. edit_page, write_page, create_node et suggest_edit remplacent chaque espace réservé par les données d’origine issues du contenu actuel de la page cible. Si un espace réservé ne correspond à aucune donnée de la page cible, Mintlify refuse l’écriture, ne modifie rien et renvoie inline_data_unresolved. Copiez les espaces réservés uniquement à partir d’un read de la même page. Si Mintlify ne peut pas lire la page pour restaurer les espaces réservés, il renvoie inline_data_source_unreadable et ne modifie rien. Réessayez l’appel.

Téléversements

  • upload_file : Démarre le téléversement d’un fichier local. Transmettez le path de destination, le contentType du fichier et sa size exacte en octets. Renvoie un uploadId, une uploadUrl présignée et les headers à envoyer avec le téléversement.
  • finalize_file_upload : Enregistre une image téléversée sur branch. Transmettez l’uploadId et le même path. Renvoie le src à référencer dans le MDX avec edit_page ou write_page, ou dans les champs logo ou favicon de docs.json avec update_config.
Après upload_file, l’outil d’IA téléverse les octets du fichier vers uploadUrl avec une requête PUT et les en-têtes renvoyés. Par exemple :
Pour ajouter une image, transmettez un path d’image, comme images/dashboard.png, et la branch à upload_file. Après le téléversement, appelez finalize_file_upload. Mintlify vérifie que le contenu du fichier téléversé correspond à son extension avant de l’enregistrer. Un téléversement vers un path existant remplace cette image. Seuls les logos et les favicons peuvent être téléversés au format SVG : transmettez purpose: "logo" aux deux outils lorsque vous en téléversez un. Les images de page ne peuvent pas être au format SVG. Les images enregistrées apparaissent dans status et sont publiées avec le reste de vos modifications lorsque vous appelez publish. Pour écrire une page à partir d’un fichier Markdown local, transmettez un path .md ou .mdx avec contentType défini sur text/markdown ou text/plain. Les téléversements de pages n’ont besoin ni de branch ni de finalize_file_upload. Après le téléversement, transmettez l’uploadId à la place de content à write_page, ou comme data.uploadId à create_node. Cela évite de renvoyer l’intégralité du contenu d’une page volumineuse dans l’appel d’outil. Utilisez l’uploadId dans un délai de 10 minutes. Chaque uploadId ne fonctionne qu’une fois, sur le même projet et pour le même utilisateur ou client que celui qui l’a créé. Mintlify supprime le fichier téléversé après l’écriture. Un uploadId réutilisé ou expiré renvoie upload_not_found.

Commentaires

Travaillez avec les commentaires et suggestions que votre équipe laisse dans l’éditeur du tableau de bord.
  • read_comments: Liste les fils de commentaires et de suggestions ouverts sur une page, du plus ancien au plus récent. Transmettez path sous les mêmes formes que pour read. Chaque fil inclut un threadId, son type (comment ou suggestion), le quotedText auquel il est ancré, le suggestedText des suggestions et ses comments avec l’author, le content et le createdAt de chacun. Si le texte ancré n’existe plus sur la page, le fil inclut anchorRemoved: true et quotedText affiche la citation d’origine. Lit les fils de branch, ou de votre branche de déploiement lorsque vous l’omettez.
  • add_comment: Démarre un nouveau fil de commentaires sur une page sans modifier son contenu. Utilisez-le pour laisser un retour à votre équipe au lieu de modifier la page. Transmettez path sous les mêmes formes que pour read, le content du commentaire et quotedText : le plus court passage de texte visible et unique auquel l’ancrer, dans un seul paragraphe ou titre. Utilisez les mots affichés, pas la syntaxe Markdown ou MDX. Par exemple, citez custom domain, pas [custom domain](/path). Renvoie le nouveau threadId. Si le texte n’est pas sur la page, l’erreur est no_match. S’il correspond à plusieurs endroits, l’erreur est not_unique : citez alors un passage plus long.
  • suggest_edit: Propose une suggestion avec suivi des modifications sur une page au lieu de la modifier. Le texte original reste sur la page, barré, et le remplacement apparaît à côté. Rien ne change tant que quelqu’un n’a pas accepté ou rejeté la suggestion dans l’éditeur du tableau de bord. Transmettez path sous les mêmes formes que pour read, oldString et newString. oldString est le plus court passage de texte visible et unique à remplacer, dans un seul paragraphe ou titre. Utilisez les mots affichés, pas la syntaxe Markdown ou MDX. Transmettez un newString vide pour suggérer une suppression. Transmettez un comment facultatif pour expliquer en quoi la modification est utile. Mintlify le publie comme réponse de l’agent dans le fil de la suggestion. L’ancien paramètre note fonctionne toujours comme alias obsolète de comment. Renvoie le nouveau threadId avec originalText et suggestedText, réduits au passage qui change. Si la même suggestion est déjà ouverte, la réponse inclut alreadyExists: true et le threadId existant. Les erreurs no_match et not_unique fonctionnent comme pour add_comment. L’erreur est no_change lorsque les deux chaînes sont identiques, et conflicting_annotation lorsque le texte chevauche une autre suggestion ouverte.
  • reply_to_comment: Répond à un fil par threadId avec content. Transmettez resolve: true pour également résoudre le fil. Mintlify publie la réponse en tant qu’agent au nom de l’utilisateur qui a autorisé la connexion, et elle apparaît en direct dans l’éditeur du tableau de bord.
  • resolve_comment: Résout un fil sans répondre.
  • read_inbox: Liste votre boîte de réception du dashboard sur un projet, l’activité la plus récente en premier. La boîte de réception comprend les commentaires et mentions, les modifications suggérées, les demandes de relecture, ainsi que les pages et dossiers privés partagés avec vous. Par défaut, read_inbox renvoie les éléments ouverts. Passez state avec la valeur open, done ou all, et section avec la valeur comment, suggestion, invitation, request ou all (par défaut). La section request comprend les demandes de relecture et les invitations. Passez filter pour limiter les commentaires à mentions ou on-my-page (les pages dont vous êtes propriétaire), les suggestions à celles provenant de people ou de l’agent, ou la section request à requests ou invites. Le filtre doit correspondre à section, sauf si section vaut all. Passez dateFrom et dateTo sous forme de dates-heures ISO 8601 pour limiter les éléments selon leur dernière activité. Passez limit pour obtenir de 1 à 50 éléments par appel (20 par défaut), et renvoyez nextCursor comme cursor pour lister les éléments plus anciens. Chaque élément inclut sa category, son state, sa latestActivity et sa target. Lorsque target.thread est présent, non résolu et ne se trouve pas sur une page privée, appelez read_comments avec son filePath et répondez avec reply_to_comment, tous deux sur sa branch. Les éléments restricted n’incluent pas les détails du fil. read_inbox est en lecture seule et ne marque jamais les éléments comme lus ou terminés. Les erreurs incluent invalid_filter, invalid_date_range et invalid_cursor.
add_comment, suggest_edit, reply_to_comment et resolve_comment nécessitent une session OAuth et une branch. Ils agissent sur les fils de cette branche et fonctionnent sur votre branche de déploiement même lorsque ses modifications exigent une pull request. Vous pouvez répondre aux fils de suggestions, mais vous devez accepter ou rejeter les suggestions dans l’éditeur. Les commentaires sur les pages privées ne sont pas disponibles via l’Admin MCP. read_inbox nécessite également une session OAuth et ne renvoie que la boîte de réception d’un membre actif de l’organisation du projet.
  • list_nodes: Parcourt l’arbre de navigation de branch, ou de votre branche de déploiement lorsque vous l’omettez, 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 fichiers et dossiers téléversés (nœuds file et file_directory) n’apparaissent que lorsque vous les incluez dans le filtre de type. Chaque nœud renvoie son id, son type, son text et son parent, ainsi que path, pageId et hidden lorsqu’ils s’appliquent. Transmettez le path d’une page à read pour obtenir son contenu et son frontmatter. Les résultats se paginent via un cursor opaque. Transmettez visibility: "private" pour lister les pages privées et dossiers auxquels l’utilisateur OAuth a accès, au lieu de l’arbre de navigation de la branche. Le listing privé ignore branch et 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 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, n’a pas besoin de branch et place le nœud à la racine privée ou sous un parent private-folder-<uuid> existant. Pour les nouvelles pages, la réponse inclut une editorUrl qui ouvre la page dans votre tableau de bord. Si une page existe déjà au path indiqué sur branch, create_node écrit le nouveau contenu dans cette page au lieu d’échouer. La page conserve sa place dans la navigation, même si vous transmettez un parent différent, et la réponse inclut updated: true. Si Mintlify ajoute une nouvelle page à la navigation mais ne parvient pas à enregistrer son contenu, create_node renvoie PAGE_SEED_FAILED. Appelez à nouveau create_node avec le même path pour écrire le contenu.
  • 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-<uuid> ou private-folder-<uuid> pour renommer une page privée 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 n’ont pas besoin de branch.
  • 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 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 n’ont pas besoin de branch.
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 publish.

Configuration

  • update_config: Modifie les paramètres de premier niveau de docs.json, comme le thème, les couleurs, le logo, la barre de navigation, le pied de page, les redirections, les intégrations et le SEO. Il ne peut pas modifier navigation ; utilisez plutôt les outils de navigation. Mintlify rejette en bloc toute configuration non valide.

Skill Mintlify

  • read_skill : Lit le guide de Mintlify pour la rédaction de documentation, qui couvre les pages, les composants, les widgets, la navigation et docs.json. Il s’agit de la même skill Mintlify que celle utilisée par l’agent. Appelez-le sans path pour obtenir SKILL.md, l’index de la skill, ainsi qu’une liste files de ses fichiers de référence. Transmettez un fichier de cette liste comme path, par exemple reference/widgets.md, pour le lire. L’outil est en lecture seule et n’a pas besoin de subdomain ni de branch. Si le fichier n’existe pas, il renvoie skill_file_not_found avec la liste files.
La réponse de l’index inclut également une liste skills des skills de l’agent de votre organisation et des vôtres qui sont activées, chacune avec un name, une description et un path. Transmettez le path d’une skill, par exemple org/release-notes/SKILL.md, pour lire ses instructions. La réponse liste les fichiers de référence de la skill dans files, et vous pouvez transmettre n’importe lequel d’entre eux comme path. Les chemins des skills personnelles commencent par me/ et n’apparaissent que pour les sessions OAuth. L’Admin MCP indique aux outils d’IA d’appeler read_skill avant de rédiger, restructurer ou mettre en forme des pages, et de suivre toute skill d’organisation ou personnelle dont la description correspond à la tâche.

Gestion de projet

Les outils de gestion de projet gèrent les opérations au niveau du projet, comme la gestion des automatisations, des paramètres de projet, des domaines personnalisés, des sources Git, de l’authentification, des membres, des analyses et du partage des pages privées. Ils agissent sur le projet en direct, pas sur une branche. Chaque outil prend un subdomain correspondant au projet ciblé. Les connexions à l’échelle de l’organisation doivent transmettre subdomain. Appelez list_deployments pour le trouver. Les outils de lecture acceptent aussi subdomains, une liste de 25 projets maximum, et renvoient un résultat ou une erreur pour chacun. La plupart des outils prennent un objet request dont le champ action sélectionne l’opération. Par exemple :
Outils de lecture :
  • get_deployment_settings: Lit en un seul appel les paramètres du dashboard d’un projet, y compris les paramètres de publication de l’éditeur et de relecture, ses sources Git, l’état de ses noms d’hôte personnalisés et ses vérifications de sources. La configuration Slack et les snippets sont facultatifs.
  • get_analytics_report: Lit un rapport d’analyse prédéfini, comme les pages vues, les pages populaires, les référents, les retours, les conversations de l’assistant ou la qualité de la recherche. Sélectionnez le rapport avec request.report. Les résultats volumineux sont paginés avec maxRows et rowOffset. Pour des requêtes personnalisées, utilisez query_analytics.
  • get_analytics_schema: Lit les tables, les événements et les règles SQL acceptés par query_analytics. L’outil d’IA l’appelle une fois avant d’écrire une requête.
  • query_analytics: Exécute une requête SELECT en lecture seule sur les analyses de votre site, comme les pages vues, la recherche, l’assistant, les retours et le trafic. Les résultats sont déjà limités au projet. Si les requêtes d’analyse ne sont pas activées pour le projet, les deux outils de requête d’analyse renvoient une erreur not_enabled.
  • get_workflows: Liste les automatisations, récupère une automatisation ou parcourt ses exécutions.
  • list_repos_and_prs: Liste les dépôts connectés, les pull requests d’un dépôt ou les intégrations disponibles pour une automatisation.
Outils d’écriture :
  • update_deployment_settings: Modifie un paramètre du dashboard, comme noindex, base_path, name, disable_ai_chat, search_settings, privacy, custom_scripts ou un module complémentaire. Utilisez editor_publishing pour modifier les paramètres de relecture. Seuls les administrateurs de l’organisation peuvent les modifier, avec les mêmes règles que dans le dashboard. Utilisez update_config pour les paramètres de docs.json.
  • manage_custom_domain: Ajoute ou supprime un domaine personnalisé, provisionne son nom d’hôte ou relance la validation du nom d’hôte.
  • manage_git_source: Ajoute, met à jour, supprime ou réordonne les dépôts Git à partir desquels un projet est compilé, ou définit la source de base.
  • manage_access_auth: Configure ou supprime l’authentification du site, ajoute ou supprime des mots de passe, configure l’authentification des utilisateurs finaux ou change celle qui est active. Le changement ne conserve qu’une configuration JWT. Si la configuration active utilise un autre type, le changement échoue avec une erreur 409 et laisse votre site inchangé. Pour passer à un autre type, configurez directement la nouvelle authentification. Lorsqu’une action active l’authentification du site, y compris un passage depuis l’authentification des utilisateurs finaux, Mintlify supprime les aperçus existants qui ne disposent ni d’une connexion d’organisation ni d’une protection par mot de passe. Définissez previewDeployments sur delete_unauthenticated (par défaut), delete_all ou keep pour choisir ce qu’il advient des aperçus existants.
  • manage_workflow: Crée, met à jour, active ou désactive, supprime ou déclenche une automatisation. Dans un projet multi-dépôts, transmettez un repo_name facultatif (par exemple, mintlify/docs) lorsque vous créez ou mettez à jour une automatisation pour définir son dépôt cible. Le dépôt doit être connecté au projet. Si vous l’omettez, les nouvelles automatisations utilisent la source de base et les mises à jour conservent la cible actuelle.
  • manage_workflow_prs: Fusionne ou ferme une pull request ouverte par une exécution d’automatisation. Pour fusionner une pull request d’une branche modifiée par l’outil d’IA, utilisez plutôt publish avec merge: true.
  • manage_members_sharing: Liste, invite ou retire des membres de l’organisation, met à jour leurs rôles ou gère les autorisations et déplacements des pages privées dans les bases. Un seul appel invite jusqu’à 250 personnes et ignore celles qui sont déjà membres ou ont une invitation en attente.
Les outils d’écriture renvoient l’état mis à jour du projet dans state, afin que l’outil d’IA puisse confirmer la modification sans second appel. Chaque action vérifie les scopes accordés à la connexion et votre rôle dans le dashboard. Une action pour laquelle vous n’êtes pas autorisé renvoie une erreur comme insufficient_scope. Pour la corriger, consultez Les appels d’outils renvoient insufficient_scope.
Les écritures de gestion de projet s’appliquent immédiatement au projet en ligne. Elles ne créent pas de branche et n’ouvrent pas de pull request. Confirmez la modification prévue avant de demander à un outil d’IA de mettre à jour des automatisations, des paramètres, des domaines, l’authentification ou des membres.

Demandes de relecture

Ces outils n’apparaissent que lorsque votre projet exige une relecture avant publication. list_review_requests et request_review acceptent un branch facultatif, qui correspond par défaut à votre branche de déploiement. Sur une autre branche, une demande de relecture couvre les modifications de la branche par rapport à votre branche de déploiement. Si votre branche de déploiement est protégée par une règle de protection de branche GitHub, demandez les relectures sur une branche de fonctionnalité.
  • list_review_requests: Liste les demandes de relecture ouvertes sur une branche. Chaque demande inclut son requester, ses reviewers et leur state, ainsi que ses pages. Chaque page a un path, un title et une approval valant approved, pending ou stale si la page a changé après l’approbation et doit être relue de nouveau. Les modifications qui n’appartiennent à aucune page, comme la navigation et les paramètres du site, apparaissent sous la forme d’un seul élément intitulé Site changes.
  • request_review: Demande aux relecteurs d’approuver vos modifications en attente. Passez jusqu’à 100 pages dans les mêmes formes que pour read, et les reviewers, chacun sous forme d’email ou de role. role: "admin" sollicite tous les administrateurs. role: "editor" sollicite tous les publieurs, ou tous les éditeurs si votre organisation ne dispose pas du rôle publieur. Si vous avez des modifications en attente qui n’appartiennent à aucune page et qu’aucune autre demande ouverte ne les inclut, Mintlify ajoute l’élément Site changes à la demande. Mintlify ne sollicite que les membres actifs, autres que vous, qui peuvent approuver. Chaque relecteur reçoit un e-mail et un élément dans sa boîte de réception. Les erreurs incluent no_pending_changes lorsqu’une page n’a rien à relire, no_reviewers lorsqu’aucune personne pouvant approuver ne correspond à reviewers et review_unavailable lorsque la branche ne peut pas recevoir de demandes de relecture, comme une branche de déploiement protégée.
  • add_reviewers: Ajoute des relecteurs à une demande de relecture ouverte, par requestId, sans la retirer, comme lorsque vous ajoutez des relecteurs dans l’éditeur. Passez reviewers sous les mêmes formes que pour request_review. Les approbations existantes sont conservées. Mintlify ignore le demandeur, les personnes déjà présentes dans la demande et les membres qui ne peuvent pas approuver, et seuls les nouveaux relecteurs reçoivent un e-mail et un élément dans leur boîte de réception. Renvoie la request mise à jour et les adresses e-mail added. Les erreurs incluent request_not_found et no_reviewers.
  • withdraw_review_request: Retire une demande de relecture que vous avez faite, par requestId. Passez un reviewer avec une adresse e-mail pour retirer uniquement ce relecteur. Retirer le dernier relecteur retire la demande. Les pages conservent leurs modifications en attente.
  • approve_review_request: Approuve la demande de relecture d’une autre personne par requestId, comme en cliquant sur Approve dans l’éditeur. L’Admin MCP indique à l’outil d’IA de n’approuver que lorsque vous lui demandez d’approuver cette demande précise, et de confirmer d’abord avec vous le demandeur et les pages. Renvoie own_request pour votre propre demande, own_branch pour une branche que vous avez créée, not_reviewer si votre rôle ne peut pas approuver, changed si les modifications ont été éditées après que l’outil d’IA les a lues et github_rejected si GitHub a refusé l’approbation, par exemple parce que vous n’avez pas connecté votre compte GitHub. Sur une branche GitHub protégée, l’approbation approuve aussi la pull request dans GitHub avec votre compte connecté.
  • publish_review_request: Publie une demande de relecture approuvée par requestId, avec un title pour le message de commit, comme lorsque vous publiez les modifications approuvées d’un collègue dans l’éditeur. Les administrateurs et les publieurs peuvent publier. L’Admin MCP indique à l’outil d’IA de ne publier que lorsque vous lui demandez de publier cette demande précise. Renvoie not_approved tant que chaque page n’a pas les approbations nécessaires, navigation_held tant qu’une autre demande ouverte retient des modifications de navigation dont cette demande a besoin et not_allowed si votre rôle ne peut pas publier. Sur une branche de fonctionnalité, fusionne la pull request de la branche dans votre branche de déploiement et renvoie merged. Renvoie no_pull_request si la branche n’a pas encore de pull request (appelez d’abord publish sur la branche) et merge_not_allowed si vous devez fusionner dans l’éditeur. Suivez le deployment renvoyé avec deployment_status.

Branches et publication

  • list_deployments: Liste les projets auxquels votre connexion peut accéder, en renvoyant chaque {subdomain, name, projectType}. projectType vaut site pour un site ou workspace pour une base de connaissances. Appelez ceci pour découvrir quel subdomain transmettre.
  • create_branch: Crée une nouvelle branche à partir de votre branche de déploiement, ou de la branche existante que vous passez comme from, avec un title qui nomme aussi sa pull request. Renvoie le branchName à passer comme branch. Consultez Travailler sur une branche. Vous n’en avez pas besoin pour modifier directement la branche de déploiement.
  • list_branches: Liste les branches Git disponibles pour le dépôt d’un projet, avec un filtrage query optionnel. Renvoie les noms de branches, le nombre total et la branche de déploiement. Passez n’importe laquelle comme branch.
  • status: Liste les fichiers modifiés, les clés docs.json modifiées et le diff de navigation en attente sur branch, ou sur votre branche de déploiement lorsque vous l’omettez. Sur la branche de déploiement, liste uniquement vos modifications.
  • diff: Liste toutes les modifications entre branch et votre branche de déploiement. Chaque fichier modifié et chaque entrée docs.json incluent authors et byYou. authors liste les membres dont l’entrée contient les modifications non publiées. byYou vaut true lorsque l’entrée inclut vos propres modifications. Utilisez byYou pour distinguer vos modifications de celles d’un collègue sur une branche partagée.
  • publish: Sur la branche de déploiement, commite directement uniquement vos modifications en attente. Si votre projet exige une relecture et que vous n’êtes pas administrateur, renvoie review_required sur la branche de déploiement ou lorsque vous passez merge: true. Consultez Projets qui exigent une relecture. Sur une branche, commite les modifications en attente et renvoie la pull request de la branche, en en ouvrant une si nécessaire. Passez merge: true pour fusionner aussi la pull request lorsque les modifications sur la branche de déploiement sont autorisées. Lorsque les modifications atteignent la branche de déploiement, renvoie aussi un statut deployment à suivre avec deployment_status.
  • deployment_status: Vérifie si les modifications publiées sont en ligne sur votre site de documentation. Passez le commitSha renvoyé par publish, ou omettez-le pour vérifier le dernier déploiement. Renvoie un state parmi pending, queued, building, live, not_live, failed ou skipped, ainsi que live et un message à vous transmettre. not_live signifie que le site sert toujours une version antérieure, par exemple parce que le déploiement a été annulé ou que votre déploiement est épinglé sur une version antérieure.
  • discard: Abandonne les modifications sur branch. Sur la branche de déploiement, annule uniquement vos modifications en attente. Sur une autre branche que vous avez créée, supprime la branche et ferme sa pull request.