Beschreibung
AGENTS.md ist ein einfaches, offenes Format zur Anleitung von Codierungsagenten, das von über 60.000 Open-Source-Projekten verwendet wird. Man kann es sich als ein README für Agenten vorstellen. Traditionelle README.md-Dateien sind auf menschliche Mitwirkende zugeschnitten und bieten schnelle Einstiegsmöglichkeiten, Projektbeschreibungen und Richtlinien zur Mitwirkung. AGENTS.md ergänzt dies, indem es den zusätzlichen, manchmal detaillierten Kontext bereitstellt, den Codierungsagenten benötigen, wie z. B. Build-Schritte, Tests und Konventionen, die ein README überladen oder für menschliche Mitwirkende nicht relevant sind.
Die Trennung von AGENTS.md und README.md erfüllt mehrere Zwecke. Sie bietet Agenten einen klaren, vorhersehbaren Ort für Anweisungen, hält READMEs prägnant und konzentriert sich auf menschliche Mitwirkende und bietet präzise, agentenorientierte Anleitungen, die bestehende README- und Dokumentationen ergänzen. Anstatt eine weitere proprietäre Datei einzuführen, übernimmt AGENTS.md einen Namen und ein Format, das von jedem genutzt werden kann. Wenn Sie Codierungsagenten erstellen oder verwenden und dieses Format hilfreich finden, werden Sie ermutigt, es zu übernehmen.
Eine AGENTS.md-Datei ist mit vielen Agenten kompatibel und macht sie zu einem vielseitigen Werkzeug für Entwickler. Die von Ihnen erstellten Agentendefinitionen können nahtlos mit einem wachsenden Ökosystem von KI-Codierungsagenten und -Werkzeugen zusammenarbeiten, einschließlich openai/codex, apache/airflow, temporalio/sdk-java und PlutoLang/Pluto. Um AGENTS.md effektiv zu nutzen, sollten Sie die Datei in Ihr Projekt einfügen und das Wesentliche abdecken, indem Sie Abschnitte hinzufügen, die einem Agenten helfen, effektiv zu arbeiten. Beliebte Optionen für diese Abschnitte sind Projektübersicht, Build- und Testbefehle, Richtlinien zum Code-Stil, Testanweisungen und Sicherheitsüberlegungen.
AGENTS.md entstand aus gemeinsamen Bemühungen im Bereich der KI-Softwareentwicklung, einschließlich Beiträgen von OpenAI Codex, Amp, Jules von Google, Cursor und Factory. Das Format wird jetzt von der Agentic AI Foundation unter der Linux Foundation betreut, mit dem Engagement, es als offenes Format zu pflegen und weiterzuentwickeln, das der gesamten Entwicklergemeinschaft zugutekommt, unabhängig vom verwendeten Codierungsagenten.
AGENTS.md's Kernfunktionen
Offenes Format
Kompatibel mit mehreren Agenten
Detaillierter Kontext für Codierungsagenten
Unterstützt geschachtelte AGENTS.md-Dateien
Anleitungen für projektspezifische Anweisungen
Gemeinschaftsgetriebene Entwicklung
Betreut von der Agentic AI Foundation
Erleichtert die Zusammenarbeit über Projekte hinweg
Wie verwendet man AGENTS.md?
AGENTS.md hinzufügen: Fügen Sie die AGENTS.md-Datei in Ihr Projekt ein.
Das Wesentliche abdecken: Fügen Sie Abschnitte hinzu, die einem Agenten helfen, effektiv mit Ihrem Projekt zu arbeiten.
Zusätzliche Anweisungen hinzufügen: Geben Sie bei Bedarf zusätzliche Anleitungen.
Geschachtelte Dateien verwenden: Implementieren Sie für große Monorepos geschachtelte AGENTS.md-Dateien für Teilprojekte.
AGENTS.md's Anwendungsfälle
- Projektdokumentation
- Open-Source-Zusammenarbeit
- Agenten-Konfiguration
- Testanweisungen
- Build-Schritte
