llms.txt qui répertorie toutes les pages disponibles de votre documentation. Ce fichier est toujours à jour et ne nécessite aucun entretien. Vous pouvez également ajouter un fichier llms.txt personnalisé à la racine de votre projet.
L’authentification affecte
llms.txt et llms-full.txt de manière différente selon la configuration de votre site :- Sites entièrement authentifiés : Les deux fichiers nécessitent une authentification. Les outils d’IA qui ne peuvent pas s’authentifier ne peuvent pas y accéder.
- Sites partiellement authentifiés : Les deux fichiers sont accessibles publiquement, mais ne listent que les pages publiques et excluent les pages restreintes à des groupes d’utilisateurs.
llms.txt en ajoutant /llms.txt à l’URL de votre site de documentation. Mintlify héberge également le fichier à l’emplacement /.well-known/llms.txt pour assurer la compatibilité avec les outils qui suivent la convention .well-known.
Mintlify ajoute des en-têtes HTTP à chaque réponse de page afin que les outils d’IA puissent découvrir vos fichiers llms.txt et autres ressources d’agent sans connaître au préalable leur emplacement :
Link: Suit le format standard de l’en-tête HTTPLinkpour la découverte de ressources. Annoncellms.txt,llms-full.txt, votre catalogue d’API, la carte du serveur MCP, l’agent card et l’index des agent skills.X-Llms-Txt: Un en-tête pratique pour les outils qui vérifient la prise en charge dellms.txt.
Response headers
rel="oauth-protected-resource". Si vous servez votre documentation sous un chemin de base, chaque chemin annoncé inclut ce préfixe.
Structure du fichier llms.txt
llms.txt est un simple fichier Markdown qui contient :
- Le titre du site en tant que H1.
- La description du site sous forme de citation en dessous du titre, provenant du champ
descriptionde votre configurationdocs.json. - Des instructions personnalisées pour les agents sous forme de bloc
Agent Instructionsaprès la description, si vous définissezmarkdown.instructionsdans votredocs.json. - Des sections de contenu structurées avec des liens et une description de chaque page de votre documentation.
- Des liens vers les spécifications d’API pointant vers vos spécifications OpenAPI et AsyncAPI, si votre documentation en inclut.
- Des liens externes dans une section
Optional, pour toute URL absolue de votre navigation.
llms.txt répertorie vos pages dans l’ordre où elles apparaissent dans la navigation de votre docs.json. Les pages qui ne figurent pas dans votre navigation mais qui sont indexées parce que vous avez défini seo.indexing: "all" apparaissent en dernier, par ordre alphabétique. Les liens des pages dans le fichier llms.txt incluent une extension .md afin que les outils d’IA puissent récupérer directement la version Markdown de chaque page.
La description de chaque page provient du champ description de son frontmatter. Mintlify utilise le premier paragraphe de la description et le tronque à 300 caractères. Les pages sans champ description apparaissent dans le fichier llms.txt sans description.
Les fichiers llms.txt et llms-full.txt répertorient les pages de votre langue par défaut et de votre version par défaut. Ils excluent les pages masquées et les pages dont le frontmatter contient noindex: true, sauf si vous définissez seo.indexing: "all" dans votre docs.json.
Cette approche structurée permet aux LLMs de traiter efficacement votre documentation à un niveau global et de repérer le contenu pertinent pour les requêtes des utilisateurs, améliorant ainsi la précision et la rapidité des recherches documentaires assistées par l’IA.
Les fichiers d’index
llms.txt générés automatiquement ne peuvent pas dépasser 100 000 caractères. Pour les sites de documentation volumineux, Mintlify scinde l’index en fichiers liés sous /_llms/ afin que les agents puissent découvrir chaque page sans charger un seul fichier trop volumineux. Cette limite ne s’applique pas à llms-full.txt./_llms/* en plus de /llms.txt pour que les agents puissent suivre les liens de l’index généré. Pour une documentation hébergée sous un chemin de base, transférez <base-path>/_llms/* à la place. Les domaines personnalisés gérés par Mintlify ne nécessitent aucune configuration supplémentaire. Consultez Reverse proxy pour des conseils de routage.
Example llms.txt
llms-full.txt
llms-full.txt regroupe l’intégralité de votre site de documentation en un seul fichier servant de contexte pour les outils d’IA et l’indexation par les LLM. Chaque page apparaît sous la forme de son titre, de son URL source, de sa description et de son contenu Markdown complet.
Mintlify héberge automatiquement un fichier llms-full.txt à la racine de votre projet. Affichez votre llms-full.txt en ajoutant /llms-full.txt à l’URL de votre site de documentation. Mintlify héberge également le fichier à l’emplacement /.well-known/llms-full.txt pour assurer la compatibilité avec les outils qui suivent la convention .well-known.
Fichiers personnalisés
llms.txt ou llms-full.txt personnalisé, créez un fichier llms.txt ou llms-full.txt à la racine de votre projet. L’ajout d’un fichier personnalisé remplace le fichier généré automatiquement portant le même nom. Si vous supprimez un fichier personnalisé, Mintlify restaure le fichier généré automatiquement.
Votre fichier llms.txt ou llms-full.txt personnalisé doit comporter le titre du site en tant que niveau de titre H1. Le reste du contenu est facultatif. Consultez Format dans la spécification llms.txt pour plus d’informations sur les sections facultatives et les bonnes pratiques.