Descrição
AGENTS.md é um formato simples e aberto para orientar agentes de codificação, usado por mais de 60 mil projetos de código aberto. Pense nisso como um README para agentes. Os arquivos README.md tradicionais são adaptados para colaboradores humanos, oferecendo inícios rápidos, descrições de projetos e diretrizes de contribuição. AGENTS.md complementa isso ao fornecer o contexto extra, às vezes detalhado, que os agentes de codificação requerem, como etapas de construção, testes e convenções que podem sobrecarregar um README ou não são relevantes para colaboradores humanos.
A separação do AGENTS.md do README.md serve a múltiplos propósitos. Ela oferece aos agentes um local claro e previsível para instruções, mantém os READMEs concisos e focados em colaboradores humanos, e fornece orientações precisas e focadas em agentes que complementam o README e a documentação existentes. Em vez de introduzir outro arquivo proprietário, o AGENTS.md adota um nome e formato que podem ser utilizados por qualquer pessoa. Se você está construindo ou usando agentes de codificação e acha este formato útil, é encorajado a adotá-lo.
Um arquivo AGENTS.md é compatível com muitos agentes, tornando-o uma ferramenta versátil para desenvolvedores. As definições de agentes que você cria podem funcionar perfeitamente com um ecossistema crescente de agentes e ferramentas de codificação de IA, incluindo openai/codex, apache/airflow, temporalio/sdk-java e PlutoLang/Pluto. Para usar efetivamente o AGENTS.md, você deve adicionar o arquivo ao seu projeto e cobrir o que importa, incluindo seções que ajudem um agente a trabalhar de forma eficaz. As escolhas populares para essas seções incluem visão geral do projeto, comandos de construção e teste, diretrizes de estilo de código, instruções de teste e considerações de segurança.
O AGENTS.md surgiu de esforços colaborativos em todo o ecossistema de desenvolvimento de software de IA, incluindo contribuições do OpenAI Codex, Amp, Jules do Google, Cursor e Factory. O formato agora é administrado pela Agentic AI Foundation sob a Linux Foundation, com o compromisso de mantê-lo e evoluí-lo como um formato aberto que beneficia toda a comunidade de desenvolvedores, independentemente do agente de codificação em uso.
Recursos principais de AGENTS.md
Formato Aberto
Compatível com múltiplos agentes
Contexto detalhado para agentes de codificação
Suporta arquivos AGENTS.md aninhados
Orientação para instruções específicas do projeto
Desenvolvimento orientado pela comunidade
Administrado pela Agentic AI Foundation
Facilita a colaboração entre projetos
Como usar AGENTS.md?
Adicionar AGENTS.md: Inclua o arquivo AGENTS.md em seu projeto.
Cobrir o que importa: Adicione seções que ajudem um agente a trabalhar de forma eficaz com seu projeto.
Adicionar instruções extras: Forneça orientações adicionais conforme necessário.
Usar arquivos aninhados: Para grandes monorepos, implemente arquivos AGENTS.md aninhados para subprojetos.
Casos de uso de AGENTS.md
- Documentação de Projeto
- Colaboração em Código Aberto
- Configuração de Agentes
- Instruções de Teste
- Etapas de Construção
