llms.txt en la raíz de tu proyecto que lista todas las páginas disponibles de tu documentación. Este archivo siempre está actualizado y no requiere mantenimiento. Opcionalmente, puedes añadir un llms.txt personalizado en la raíz de tu proyecto.
La autenticación afecta a
llms.txt y llms-full.txt de forma distinta según la configuración de tu sitio:- Sitios totalmente autenticados: Ambos archivos requieren autenticación. Las herramientas de IA que no puedan autenticarse no podrán acceder a ellos.
- Sitios parcialmente autenticados: Ambos archivos son de acceso público, pero solo listan las páginas públicas y excluyen las páginas restringidas a grupos de usuarios.
llms.txt añadiendo /llms.txt a la URL de tu sitio de documentación. Mintlify también aloja el archivo en /.well-known/llms.txt para garantizar la compatibilidad con herramientas que siguen la convención .well-known.
Mintlify añade encabezados HTTP a cada respuesta de página para que las herramientas de IA puedan descubrir tus archivos llms.txt y otros recursos para agentes sin conocer previamente su ubicación:
Link: Sigue el formato estándar del encabezado HTTPLinkpara el descubrimiento de recursos. Anunciallms.txt,llms-full.txt, tu catálogo de API, tarjeta del servidor MCP, tarjeta del agente e índice de skills del agente.X-Llms-Txt: Un encabezado de conveniencia para herramientas que verifican la compatibilidad conllms.txt.
Response headers
rel="oauth-protected-resource". Si sirves tu documentación bajo una ruta base, todas las rutas anunciadas incluyen ese prefijo.
Estructura del archivo llms.txt
llms.txt es un archivo Markdown sin formato que contiene:
- Título del sitio como encabezado H1.
- Descripción del sitio como una cita debajo del título, obtenida del campo
descriptionen tu configuracióndocs.json. - Instrucciones personalizadas para agentes como un bloque
Agent Instructionsdespués de la descripción, si establecesmarkdown.instructionsen tudocs.json. - Secciones de contenido estructuradas con enlaces y una descripción de cada página de tu documentación.
- Enlaces a especificaciones de API a tus especificaciones OpenAPI y AsyncAPI, si tu documentación las incluye.
- Enlaces externos en una sección
Optional, para cualquier URL absoluta de tu navegación.
llms.txt lista tus páginas en el orden en que aparecen en la navegación de tu docs.json. Las páginas que no están en tu navegación pero se indexan porque estableciste seo.indexing: "all" aparecen al final, en orden alfabético. Los enlaces de las páginas en el archivo llms.txt incluyen la extensión .md para que las herramientas de IA puedan obtener directamente la versión Markdown de cada página.
La descripción de cada página proviene del campo description en su frontmatter. Mintlify usa el primer párrafo de la descripción y lo trunca a 300 caracteres. Las páginas sin el campo description aparecen en el archivo llms.txt sin descripción.
Tanto llms.txt como llms-full.txt listan las páginas de tu idioma predeterminado y de tu versión predeterminada. Excluyen las páginas ocultas y las páginas con noindex: true en su frontmatter, a menos que establezcas seo.indexing: "all" en tu docs.json.
Este enfoque estructurado permite a los LLM procesar tu documentación de forma eficiente a un alto nivel y localizar contenido relevante para las consultas de los usuarios, mejorando la precisión y la velocidad de las búsquedas de documentación asistidas por IA.
Índices divididos bajo /_llms
llms.txt generados automáticamente no pueden superar los 100.000 caracteres. Cuando un índice supera este límite, Mintlify mantiene el archivo llms.txt principal como un directorio y traslada grupos de enlaces de páginas a archivos Markdown generados bajo /_llms/. Todas las páginas siguen siendo descubribles: la división nunca omite páginas del índice. Este límite no se aplica a llms-full.txt.
Los enlaces a los índices generados aparecen en una sección Indexes. Cada enlace incluye la ruta de navegación del grupo, su número de páginas y una descripción:
/_llms/api-reference.md puede enlazar a /_llms/api-reference/admin.md cuando un grupo es demasiado grande para un solo archivo. Los agentes deben seguir estos enlaces de índice de forma recursiva hasta llegar a los enlaces de las páginas de documentación. Mintlify puede acortar las descripciones de las páginas en un índice dividido para mantener cada archivo por debajo del límite de caracteres.
Los archivos generados forman parte de llms.txt y no necesitan existir en tu repositorio. Son independientes de llms-full.txt.
La ruta /_llms/ usa la misma ruta base que tu documentación:
- Un sitio alojado en la raíz sirve un índice en
https://docs.example.com/_llms/api-reference.md. - Un sitio alojado en
/docslo sirve enhttps://example.com/docs/_llms/api-reference.md.
llms.txt. Una regla amplia <base-path>/* ya incluye <base-path>/_llms/*. Con reglas granulares, añade <base-path>/_llms/* de forma explícita. Consulta Proxy inverso para obtener orientación sobre el enrutamiento.
Example llms.txt
llms-full.txt
llms-full.txt reúne todo tu sitio de documentación en un único archivo como contexto para herramientas de IA y la indexación de los LLM. Cada página aparece como su título, URL de origen, descripción y contenido Markdown completo.
Mintlify aloja automáticamente un archivo llms-full.txt en la raíz de tu proyecto. Visualiza tu llms-full.txt agregando /llms-full.txt a la URL de tu sitio de documentación. Mintlify también aloja el archivo en /.well-known/llms-full.txt para garantizar la compatibilidad con herramientas que siguen la convención .well-known.
Archivos personalizados
llms.txt o llms-full.txt, crea un archivo llms.txt o llms-full.txt en la raíz de tu proyecto. Agregar un archivo personalizado reemplazará el archivo generado automáticamente con el mismo nombre. Si eliminas un archivo personalizado, Mintlify restaura el archivo generado automáticamente.
Tu archivo personalizado llms.txt o llms-full.txt debe incluir el título del sitio como encabezado H1. El resto del contenido es opcional. Consulta Format en la especificación de llms.txt para obtener más información sobre secciones opcionales y buenas prácticas.
En los sitios que usan autenticación, los archivos personalizados
llms.txt y llms-full.txt respetan la autenticación.Si un archivo personalizado enlaza a alguna página que no es pública, solo los usuarios autenticados pueden acceder al archivo. Los visitantes anónimos reciben el llms.txt o llms-full.txt generado automáticamente, que solo incluye enlaces disponibles públicamente.