Saltar al contenido principal
Crea un archivo .mintlify/AGENTS.md en la raíz de tu proyecto de documentación para personalizar el comportamiento del agente (también se acepta Agents.md como nombre de archivo).
Coloca tu archivo AGENTS.md dentro del directorio .mintlify/, no en la raíz de tu proyecto. Si almacenas el archivo en la raíz de tu proyecto, tus instrucciones personalizadas serán accesibles públicamente a través de la ruta /agents.md. El directorio .mintlify/ no se sirve públicamente, por lo que tu archivo AGENTS.md no será accesible cuando esté en ese directorio.Si necesitas almacenar tu archivo AGENTS.md en la raíz de tu proyecto o en cualquier otro directorio, agrégalo a tu archivo .mintignore para excluirlo de tu sitio de documentación.
Añade todas las instrucciones que quieras que el agente siga. El agente agrega estas instrucciones a su prompt del sistema, por lo que se aplican a todas las tareas, tanto si usas el agente en Slack como mediante la API.
El agente integrado del editor no lee AGENTS.md. Para dar al agente del editor una guía persistente, configura las instrucciones de IA en la configuración del editor.

Qué incluir en AGENTS.md

Considera agregar instrucciones sobre:
  • Preferencias de estilo: Voz, tono, formato y terminología específica de tu documentación.
  • Estándares de código: Lenguajes de programación, frameworks y convenciones de codificación que se deben usar en los ejemplos.
  • Requisitos de contenido: Qué secciones o información se deben incluir para diferentes tipos de páginas.
  • Contexto del proyecto: Detalles específicos sobre tu producto, arquitectura o base de usuarios que guíen las decisiones sobre la documentación.

Ejemplo de archivo AGENTS.md

.mintlify/AGENTS.md