Описание
AGENTS.md — это простой, открытый формат для руководства кодирующими агентами, используемый более чем 60 000 открытыми проектами. Рассматривайте его как README для агентов. Традиционные файлы README.md ориентированы на человеческих участников, предлагая быстрые старты, описания проектов и руководства по вкладу. AGENTS.md дополняет это, предоставляя дополнительный, иногда детализированный контекст, который необходим кодирующим агентам, такой как шаги сборки, тесты и соглашения, которые могут загромождать README или не имеют отношения к человеческим участникам.
Отделение AGENTS.md от README.md служит нескольким целям. Оно предоставляет агентам четкое, предсказуемое место для инструкций, сохраняет README краткими и сосредоточенными на человеческих участниках и предоставляет точные, ориентированные на агентов рекомендации, которые дополняют существующие README и документацию. Вместо того чтобы вводить еще один проприетарный файл, AGENTS.md принимает название и формат, которые могут использовать все. Если вы разрабатываете или используете кодирующих агентов и находите этот формат полезным, вам предлагается его принять.
Один файл AGENTS.md совместим с множеством агентов, что делает его универсальным инструментом для разработчиков. Определения агентов, которые вы создаете, могут бесшовно работать с растущей экосистемой AI-кодирующих агентов и инструментов, включая openai/codex, apache/airflow, temporalio/sdk-java и PlutoLang/Pluto. Чтобы эффективно использовать AGENTS.md, вы должны добавить файл в ваш проект и охватить важные моменты, включая разделы, которые помогут агенту работать эффективно. Популярные варианты для этих разделов включают обзор проекта, команды сборки и тестирования, рекомендации по стилю кода, инструкции по тестированию и соображения по безопасности.
AGENTS.md возник из совместных усилий в экосистеме разработки программного обеспечения AI, включая вклад OpenAI Codex, Amp, Jules из Google, Cursor и Factory. Формат теперь управляется Фондом Agentic AI под эгидой Фонда Linux, с обязательством поддерживать и развивать его как открытый формат, который приносит пользу всему сообществу разработчиков, независимо от используемого кодирующего агента.
Основные функции AGENTS.md
Открытый формат
Совместимость с несколькими агентами
Детализированный контекст для кодирующих агентов
Поддержка вложенных файлов AGENTS.md
Руководство по специфическим инструкциям проекта
Разработка на основе сообщества
Управляется Фондом Agentic AI
Содействует сотрудничеству между проектами
Как использовать AGENTS.md?
Добавьте AGENTS.md: Включите файл AGENTS.md в ваш проект.
Охватите важные моменты: Добавьте разделы, которые помогут агенту эффективно работать с вашим проектом.
Добавьте дополнительные инструкции: Предоставьте дополнительные рекомендации по мере необходимости.
Используйте вложенные файлы: Для больших монорепозиториев реализуйте вложенные файлы AGENTS.md для подпроектов.
Варианты использования AGENTS.md
- Документация проекта
- Сотрудничество с открытым исходным кодом
- Конфигурация агента
- Инструкции по тестированию
- Шаги сборки
