AGENTS.md fournissent à Codex un contexte persistant sur vos standards de documentation, vos composants et votre guide de style.
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 structure de 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
~/.codex/config.toml :