- AGENTS.md complementa a README y funciona como un archivo dedicado que contiene el contexto y las instrucciones que necesita un agente de codificación con IA al trabajar en un proyecto
- Ya se usa en más de 20,000 proyectos de código abierto, organizando información como build/test/estilo de código que no es necesaria para las personas, pero sí importante para los agentes
- Proporciona instrucciones específicas para agentes en una ubicación clara y predecible, manteniendo README conciso y al mismo tiempo mejorando la eficiencia de la colaboración
- Un solo AGENTS.md es compatible con distintos agentes y herramientas, y en monorepos grandes se pueden usar AGENTS.md individuales por subproyecto
- Un estándar abierto creado con la colaboración de varios ecosistemas, como OpenAI Codex, Cursor y Google Jules
Why AGENTS.md?
- README.md es documentación para personas, y ofrece inicio rápido, descripción del proyecto y lineamientos de contribución
- AGENTS.md es un documento auxiliar para agentes que incluye contexto detallado como reglas de build/test/código sin volver complejo el README
- Razones para tenerlo como archivo separado
- Ofrece a los agentes una ubicación predecible para las instrucciones que deben consultar
- README se mantiene conciso y centrado en contribuyentes humanos
- Proporciona instrucciones precisas específicas para agentes que complementan la documentación existente
- Adopta una denominación de estándar abierto que cualquiera puede usar, en lugar de un formato propietario
- Con un solo AGENTS.md, es compatible con varios agentes de codificación con IA y herramientas
How to use AGENTS.md?
- 1. Crear el archivo AGENTS.md
- Colocarlo en la raíz del repositorio (muchos agentes admiten su creación automática)
- 2. Escribir los apartados principales
- Resumen del proyecto
- Comandos de build y test
- Lineamientos de estilo de código
- Cómo ejecutar pruebas
- Consideraciones de seguridad
- 3. Incluir instrucciones adicionales
- Reglas de commit/PR, precauciones de seguridad, datasets grandes, pasos de despliegue y otros puntos que el equipo quiera transmitir
- 4. Soporte para monorepos
- Se puede colocar un AGENTS.md para cada paquete
- El agente lee el archivo más cercano y sigue las instrucciones correspondientes a ese subproyecto
- Ejemplo: el repositorio de OpenAI tiene 88 archivos AGENTS.md
FAQ
- Elementos obligatorios: ninguno; se puede usar libremente el formato general de Markdown
- Si hay conflictos: tiene prioridad el AGENTS.md más cercano, y el prompt explícito del usuario se aplica al final
- Ejecución automática: el agente puede ejecutar los comandos de prueba indicados en el archivo para intentar corregir errores
- Posibilidad de actualización: se puede cambiar en cualquier momento; se gestiona como un documento vivo
- Migración de documentación existente: cambiar el nombre del archivo y mantener compatibilidad con un enlace simbólico
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
Aún no hay comentarios.