- AGENTS.md ergänzt die README und ist eine spezielle Datei mit Kontext und Anweisungen, die AI-Coding-Agenten für die Arbeit in einem Projekt benötigen
- Wird bereits in mehr als 20.000 Open-Source-Projekten genutzt und bündelt Informationen wie Build/Test/Code-Stil, die für Menschen unnötig, für Agenten jedoch wichtig sind
- Bietet agentenspezifische Anweisungen an einem klaren und vorhersehbaren Ort, hält die README schlank und verbessert zugleich die Effizienz der Zusammenarbeit
- Eine einzige AGENTS.md ist mit verschiedenen Agenten und Tools kompatibel; in großen Monorepos sind auch separate AGENTS.md-Dateien pro Teilprojekt möglich
- Ein offener Standard, entstanden durch die Zusammenarbeit mehrerer Ökosysteme wie OpenAI Codex, Cursor und Google Jules
Why AGENTS.md?
- README.md ist Dokumentation für Menschen und bietet Schnellstart, Projektbeschreibung und Richtlinien für Beiträge
- AGENTS.md ist ein ergänzendes Dokument für Agenten, das Detailkontext wie Build-/Test-/Code-Regeln enthält, ohne die README unnötig komplex zu machen
- Warum eine separate Datei?
- Sie bietet Agenten einen vorhersehbaren Ort für Anweisungen
- Die README bleibt knapp und auf menschliche Beitragende ausgerichtet
- Sie liefert präzise, agentenspezifische Anweisungen, die bestehende Dokumentation ergänzen
- Statt eines proprietären Formats wurde die Bezeichnung eines offenen Standards gewählt, den jeder nutzen kann
- Eine AGENTS.md ist mit mehreren AI-Coding-Agenten und Tools kompatibel
How to use AGENTS.md?
- 1. AGENTS.md-Datei erstellen
- Im Repository-Root ablegen (viele Agenten unterstützen die automatische Erstellung)
- 2. Wichtige Punkte schreiben
- Projektüberblick
- Build- und Test-Befehle
- Code-Style-Richtlinien
- Testmethoden
- Sicherheitsaspekte
- 3. Zusätzliche Anweisungen aufnehmen
- Alles, was dem Team mitgeteilt werden soll, z. B. Commit-/PR-Regeln, Sicherheitshinweise, große Datensätze oder Deployment-Schritte
- 4. Monorepo-Unterstützung
- Für jedes Paket kann eine eigene AGENTS.md abgelegt werden
- Agenten lesen die nächstgelegene Datei und befolgen die Anweisungen für das jeweilige Teilprojekt
- Beispiel: Im OpenAI-Repository gibt es 88 AGENTS.md-Dateien
FAQ
- Pflichtfelder: keine, normales Markdown kann frei verwendet werden
- Bei Konflikten: Die nächstgelegene AGENTS.md hat Vorrang, ein expliziter Prompt des Nutzers gilt zuletzt
- Automatische Ausführung: Im Dokument angegebene Testbefehle werden vom Agenten ausgeführt, um Fehlerbehebungen zu versuchen
- Aktualisierbarkeit: Kann jederzeit geändert werden und wird als lebendes Dokument gepflegt
- Migration bestehender Dokumente: Kompatibilität bleibt durch Umbenennen der Datei und einen symbolischen Link erhalten
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
Noch keine Kommentare.