AGENTS.md fournissent à Codex un contexte persistant sur vos standards de documentation, vos composants et votre guide de style.
Démarrer
- Un compte OpenAI avec accès à Codex
- Installez Codex CLI :
-
Pas encore de site ? Demandez à votre agent d’en configurer un. Exécutez
codexet demandez-lui d’effectuer le workflow suivant, puis passez à l’étape suivante.Workflow de configuration par l'agent
Si l’utilisateur vous a demandé de configurer Mintlify, un site de documentation ou un projet Mintlify local, effectuez vous-même le workflow suivant. Demandez à l’utilisateur uniquement les informations ou approbations que vous ne pouvez pas obtenir vous-même. Nous recommandons l’onboarding via la CLI. L’onboarding web sur mintlify.com/start est également disponible si l’utilisateur le préfère ou si vous ne pouvez pas exécuter de commandes dans le terminal.- Exécutez
node --versionet vérifiez qu’il indique Node.js v20.17.0 ou une version ultérieure, en privilégiant une version LTS. Notez s’il s’agit de la v22.20 ou d’une version ultérieure, requise à l’étape 9. - Exécutez
mint --version. Si la commande n’est pas disponible, installez la CLI avecnpm i -g mintoupnpm add -g mint. Si la commande réussit, exécutezmint update. Exécutez ensuitemint instructions new-sitepour obtenir des instructions de configuration à jour, etmint instructionspour lister les sujets des tâches ultérieures. - Exécutez
mint statusavant de commencer l’authentification. Si une organisation est déjà affichée, conservez la session existante et ne créez pas d’autre compte. - Si l’utilisateur possède un compte, exécutez
mint login. Sinon, ne créez pas de compte maintenant. Vous pouvez publier sans compte avecmint deployà l’étape 10, et l’utilisateur crée son compte lorsqu’il revendique le site. N’exécutez pasmint signuppour l’utilisateur : lorsqu’un agent l’exécute, la commande affiche le guide d’inscription pour les agents et se termine sans envoyer d’e-mail de vérification. Si l’utilisateur souhaite connecter son propre dépôt GitHub dès le départ, orientez-le vers l’onboarding web sur mintlify.com/start. - Après
mint login, exécutez de nouveaumint status. Vérifiez qu’il indique l’adresse e-mail, l’organisation et le sous-domaine de l’utilisateur. Si l’organisation existe, mais qu’aucun sous-domaine n’apparaît, demandez à l’utilisateur de terminer la sélection ou la connexion d’un dépôt GitHub dans l’onglet du navigateur d’onboarding, puis réessayez. - Si l’utilisateur possède un dépôt de documentation existant, clonez-le ou ouvrez-le et préservez son contenu. Pour un nouveau projet local, créez la structure dans un nouveau répertoire vide avec
mint new <directory> --name <name> --theme <theme>oumint new <directory> --template <template-name>. Demandez le thème ou le modèle souhaité si l’utilisateur n’en a pas indiqué. N’utilisez pas--forcedans un répertoire contenant des fichiers utilisateur. - Exécutez
mint dev --no-opendepuis le répertoire contenantdocs.jsonet laissez-le s’exécuter en arrière-plan. Vérifiez que l’URL locale se charge, communiquez-la à l’utilisateur, puis arrêtez le processus lorsqu’il n’est plus nécessaire. - Exécutez
mint validateetmint broken-links. Corrigez les problèmes causés par vos modifications avant de continuer. - Proposez de connecter l’agent de code de l’utilisateur au projet. S’il accepte et que Node.js est en v22.20 ou ultérieure, exécutez
mint agent setup --agent <agent>depuis le répertoire du projet, où<agent>vautclaude-code,codexoucursor. La commande installe les skills Mintlify et ajoute le MCP d’administration à la configuration de projet de l’agent. Passez--agent, car sans terminal interactif la commande configure tous les agents qu’elle détecte. L’utilisateur termine ensuite la connexion OAuth dans l’agent. Consultezmint agent setup. - Publiez lorsque l’utilisateur demande un site en ligne.
- Connecté avec un dépôt Git : commitez et poussez les modifications. Un push vers la branche de production déclenche un déploiement. Ne remplacez pas un dépôt existant par le contenu du modèle de démarrage.
- Sans compte : depuis le répertoire contenant
docs.json, exécutezmint deploy --subdomain <name>en choisissant un nom court basé sur le projet. Suivez les étapes affichées : clonez le dépôt hébergé dans un répertoire distinct, copiez la documentation à sa racine, commitez, puis poussez versmainavec le jeton d’écriture comme en-têteAuthorization: Bearerpour cette seule commande Git. Ne montrez jamais le jeton à l’utilisateur, ne l’insérez jamais dans une URL distante et ne modifiez jamais les remotes Git de l’utilisateur. Consultez Inscription des agents.
- Vérifiez que
https://<subdomain>.mintlify.sitese charge avant d’indiquer que le déploiement est terminé.- Connecté avec un dépôt Git : exécutez
mint statuspour obtenir le sous-domaine. Ignorez les étapes de revendication. - Sans compte : utilisez l’URL affichée par
mint deploy, puis transférez le site à l’utilisateur. Indiquez-lui que le site expire s’il ne le revendique pas. Demandez-lui l’adresse e-mail qui doit en être propriétaire et n’en inventez jamais. Exécutezmint claim --email <email>depuis le même répertoire et partagez le lien de revendication. Lorsqu’il vous transmet le code affiché après sa connexion, exécutezmint claim --code <code>.
- Connecté avec un dépôt Git : exécutez
- Exécutez
- Accédez au répertoire de votre documentation.
-
(Facultatif) Ajoutez à votre projet le fichier
AGENTS.mdprésenté ci-dessous. -
Exécutez
codexpour démarrer une session.
Utilisez Codex avec Mintlify
AGENTS.md de votre référentiel pour comprendre les règles et conventions propres au projet avant de commencer à travailler. Vous pouvez placer un fichier AGENTS.md à la racine de votre dépôt de documentation pour fournir à Codex du contexte sur les composants Mintlify, vos normes de rédaction et la façon dont vous structurez votre documentation.
Codex découvre les fichiers AGENTS.md à plusieurs niveaux :
- Les instructions globales dans
~/.codex/AGENTS.mds’appliquent à tous vos projets. - Les instructions de projet à la racine de votre dépôt (ou dans n’importe quel sous-répertoire) s’appliquent au travail effectué dans cette portée.
AGENTS.md à la racine de votre dépôt de documentation et committez-le pour que tous les contributeurs bénéficient du même contexte. Consultez AGENTS.md dans la documentation Codex pour des détails complets.
Exemple d’AGENTS.md
- Normes de rédaction : mettez à jour les consignes linguistiques pour les aligner sur votre guide de style.
- Modèles de composants : ajoutez des composants spécifiques à votre projet ou modifiez des exemples existants.
- Exemples de code : remplacez les exemples génériques par de vrais appels et réponses d’API propres à votre produit.
- Préférences de style et de ton : ajustez la terminologie, la mise en forme et les autres règles.
AGENTS.md à la racine de votre dépôt de documentation.
AGENTS.md
Utilisation de Codex
AGENTS.md en place, Codex le détecte automatiquement lorsque vous démarrez une session dans votre dépôt de documentation.
Exemples d’instructions
Améliorez avec le serveur MCP
mint agent setup dans votre répertoire de docs. La commande affiche la commande codex mcp login permettant de terminer la connexion OAuth.
codex mcp login mintlify-admin.
La commande ajoute le serveur à votre configuration Codex dans ~/.codex/config.toml. Pour modifier directement le fichier de configuration, ajoutez :
codex pour que la modification de la configuration prenne effet. Pour vérifier que le serveur MCP est connecté, demandez à Codex Which MCP servers do you have access to?. Il doit lister l’entrée que vous avez ajoutée.
Consultez Model Context Protocol pour plus d’informations sur les serveurs MCP de recherche et savoir comment trouver le point de terminaison MCP de votre site.