Saltar al contenido

El blog de Deska

AGENTS.md: El archivo de configuración que todo repositorio debería tener ahora

Aprende cómo AGENTS.md ayuda a las IA a entender tu código. Domina este archivo de instrucciones para mejores flujos de desarrollo automatizados.

10 min de lectura

El desarrollo moderno depende cada vez más de los modelos de lenguaje de gran tamaño para ayudar con la refactorización, la depuración y la implementación de funcionalidades. A medida que estas herramientas evolucionan, proporcionar un contexto coherente se convierte en un cuello de botella crítico. Aquí es donde una guía AGENTS.md sirve como una solución estandarizada, actuando como un archivo de instrucciones para múltiples agentes que le indica a los asistentes de programación mediante IA exactamente cómo interactuar con tu código específico. Al colocar este archivo en la raíz de tu repositorio, aseguras que cada agente, independientemente de su arquitectura específica, siga tus patrones arquitectónicos, requisitos de prueba y protocolos de despliegue sin necesidad de indicaciones manuales en cada sesión.

La convergencia del contexto del proyecto

Durante años, los desarrolladores han utilizado README.md para incorporar a colaboradores humanos. Este archivo suele incluir resúmenes de alto nivel que los humanos escanean, omiten o interpretan a través de la intuición. Los agentes de IA no tienen intuición. Operan mejor cuando se les proporcionan restricciones estructuradas y explícitas. Un archivo AGENTS.md crea un puente entre el código base y el motor de razonamiento del agente.

Aunque diferentes herramientas exploran sus propias formas de manejar el contexto, hay una tendencia clara hacia la estandarización. Algunos entornos utilizan directorios ocultos o formatos de configuración propietarios. Sin embargo, un archivo Markdown es portátil, está controlado por versiones y es legible instantáneamente por cualquier LLM que realice un listado de directorios. Reduce la tasa de alucinaciones al definir la fuente de verdad para las reglas del proyecto.

Qué debe incluir tu AGENTS.md

Un archivo de instrucciones completo no debe simplemente repetir el README. Debe abordar las especificidades técnicas que un agente de IA podría pasar por alto durante una simple búsqueda en el sistema de archivos. Considera incluir las siguientes categorías:

  • Detalles del stack tecnológico: Especifica versiones exactas y librerías preferidas, especialmente si el proyecto utiliza versiones antiguas que entran en conflicto con los datos de entrenamiento del LLM.
  • Patrones de arquitectura: Define si el proyecto utiliza Arquitectura Hexagonal, Feature-Sliced Design o un enfoque MVC tradicional.
  • Protocolos de prueba: Explica cómo ejecutar las pruebas, dónde deben residir las nuevas pruebas y los umbrales de cobertura requeridos.
  • Estilo de código: Menciona reglas específicas de linting o convenciones de nombres que no sean impuestas estrictamente por el compilador.
  • Patrones prohibidos: Enumera explícitamente librerías, funciones o patrones que el agente nunca debe usar, como APIs obsoletas.

Cómo interpretan las reglas las herramientas modernas

La mayoría de los asistentes de programación funcionan ingiriendo contexto a través de una combinación de RAG (Generación Aumentada por Recuperación) y acceso directo a archivos. Cuando un agente entra en un repositorio, su primera tarea suele ser buscar un mapa. Las herramientas como Claude Code o Codex CLI están diseñadas para rendir mejor cuando tienen límites claros.

En el ecosistema de Deska, este archivo juega un papel fundamental. Deska es una aplicación de escritorio gratuita para Mac, Windows y Linux que proporciona un lienzo infinito para el desarrollo. Dentro de este espacio de trabajo, puedes ejecutar múltiples herramientas una al lado de la otra en paneles, incluyendo asistentes de programación especializados. Debido a que Deska es un entorno local-first, tu archivo AGENTS.md permanece en tu máquina, asegurando que tus secretos arquitectónicos se mantengan privados mientras sigues guiando a la IA.

Cuando utilizas los agentes de programación integrados en Deska, estos pueden acceder al sistema de archivos local directamente. Si tu proyecto contiene un archivo AGENTS.md, estos agentes pueden consultarlo para asegurar que no sugieran un hook de React en un componente de Vue o viceversa. Esto es particularmente útil cuando tienes varios paneles abiertos, como una terminal y un editor de código, y quieres que la IA comprenda la relación entre ellos.

Estructuración del archivo para máxima claridad de la IA

Escribir para una IA requiere una mentalidad diferente a la de escribir para un humano. Usa un lenguaje claro e imperativo. Evita el relleno y enfócate en restricciones accionables.

  1. Usa jerarquías de encabezados: Utiliza etiquetas H2 y H3 para categorizar la información de modo que el agente pueda navegar la estructura del documento fácilmente.
  2. Proporciona ejemplos: Si deseas un estilo específico de documentación o prueba unitaria, incluye un pequeño bloque de código como referencia.
  3. Define comandos de flujo de trabajo: Enumera los comandos CLI específicos para construir, realizar linting y arrancar el servidor de desarrollo.
  4. Frecuencia de actualización: Trata este archivo como un documento vivo. Cada vez que se tome una nueva decisión arquitectónica, actualiza el AGENTS.md antes incluso de abrir un PR.

Comparación de enfoques para la orquestación de agentes

Diferentes IDEs y editores tienen formas experimentales de gestionar el contexto. Algunos utilizan archivos de configuración ocultos, mientras que otros dependen de la indexación basada en la nube. Estos métodos difieren en enfoque respecto a un archivo Markdown de texto plano. La ventaja del enfoque Markdown es su universalidad; funciona en VS Code, Vim y aplicaciones de escritorio independientes.

Para los desarrolladores que prefieren un entorno especializado, Deska ofrece un espacio de trabajo donde puedes ejecutar Claude Code, Codex CLI y OpenCode simultáneamente. Al ver a estos agentes operar en paneles paralelos, puedes observar cómo reacciona cada uno a tus instrucciones en AGENTS.md. Es posible que descubras que un agente es mejor siguiendo reglas arquitectónicas mientras que otro destaca escribiendo los casos de prueba reales basados en esas reglas.

Consideraciones de privacidad y seguridad

Una de las mayores preocupaciones con el desarrollo mediante IA es a dónde van tus datos. Si utilizas editores basados en la nube, el contexto de tu proyecto suele almacenarse en servidores remotos. Un enfoque local-first mitiga este riesgo. Al mantener tus instrucciones y tu código en tu máquina física, tú controlas el flujo de datos.

Deska apoya esto permitiéndote usar tus propias llaves de API, o BYOK, para el nivel de por vida. Esto significa que tus datos y almacenamiento permanecen bajo tu jurisdicción. Incluso al usar la aplicación móvil para monitorear el progreso a través de un relevo seguro, los dispositivos se emparejan directamente sin exponer puertos a la internet abierta. Tu archivo AGENTS.md, por lo tanto, actúa como una guía local que nunca necesita ser indexada por un tercero externo.

FAQ: Preguntas comunes sobre archivos de instrucciones para IA

¿Cómo evito que un agente de IA ignore mi AGENTS.md?

La mayoría de los agentes responden a un prompt del sistema que les indica que siempre revisen primero si existe un archivo de configuración. También puedes señalar explícitamente el archivo al agente en tu sesión de chat inicial. En Deska, puedes usar Ask Deska, el asistente de voz y chat, para indicarle a los agentes del espacio de trabajo que prioricen la lectura de los archivos markdown de la raíz.

¿Debería poner AGENTS.md en el gitignore?

No, se recomienda encarecidamente incluir este archivo en tu repositorio de git. Esto garantiza que cada desarrollador de tu equipo, y cada agente que ejecuten, esté operando bajo el mismo conjunto de restricciones. Sirve como el equivalente automatizado de una guía de contribución.

¿Puedo tener múltiples archivos de instrucciones para agentes?

Aunque un solo archivo es más fácil de gestionar, los monorepositorios grandes podrían beneficiarse de colocar instrucciones específicas en subdirectorios. Sin embargo, la mayoría de las herramientas de LLM actuales buscan primero un archivo a nivel de raíz. Mantener un único AGENTS.md bien estructurado en el directorio raíz suele ser el mejor enfoque para la consistencia.

Optimizando tu flujo de trabajo

Adoptar un archivo de instrucciones para múltiples agentes es una pequeña inversión que rinde beneficios cada vez que un asistente de IA sugiere código que realmente se ajusta al estilo de tu proyecto. Ya sea que estés usando terminales especializadas o un lienzo visual, tener una fuente de verdad para los miembros de tu equipo de IA es esencial.

Si buscas una manera de gestionar estos agentes de forma más efectiva, puedes descargar Deska para comenzar a construir en un entorno diseñado para flujos de trabajo modernos basados en agentes. Al ejecutar tus herramientas de programación una al lado de la otra en un lienzo infinito, obtienes la visibilidad necesaria para escalar tus esfuerzos de desarrollo sin perder de vista las reglas de tu proyecto.