Erstellen Sie Schritt für Schritt eine AGENTS.md-Datei

Eine AGENTS.md-Datei ist eine einzelne Markdown-Datei in Ihrem Repository-Root. Sie teilt KI-Coding-Agenten mit, wie sie arbeiten sollen. Sie deckt Build-Schritte, Tests und Regeln ab.

Folgen Sie diesen Schritten, um eine für ein Python FastAPI-Projekt zu erstellen.

  1. Den Stack definieren Beginnen Sie mit einem Satz. Nennen Sie dem Agenten die Sprache, das Framework und die Datenbank. Beispiel: Eine URL-Shortener-API in Python unter Verwendung von FastAPI, SQLite und pytest.

  2. Setup-Befehle bereitstellen Geben Sie dem Agenten echte Befehle zum Ausführen. Verwenden Sie keine Platzhalter.

  • Setup: python -m venv .venv && source .venv/bin/activate
  • Run: uvicorn app.main:app --reload
  1. Die Messlatte für Tests festlegen Dies ist entscheidend. Der Agent nutzt Tests, um seine eigene Arbeit zu überprüfen.
  • pytest ausführen
  • ruff check ausführen
  • mypy ausführen
  1. Die Struktur abbilden Listen Sie Ihre Ordner auf, damit der Agent nicht jede Datei durchsuchen muss.
  • app/main.py: Route-Handler
  • app/db.py: SQLite-Zugriff
  • migrations/: generiertes SQL (nicht bearbeiten)
  1. Konventionen definieren Seien Sie spezifisch. Vage Regeln sind nutzlos.
  • Verwenden Sie Pydantic für die gesamte Input-Validierung.
  • Werfen Sie HTTPException bei Client-Fehlern.
  • Typisieren Sie alles, um mypy sauber zu halten.
  1. Die „Don'ts“ auflisten Verhindern Sie Fehler, indem Sie klare Grenzen setzen.
  • Bearbeiten Sie Migrationen nicht manuell.
  • Committen Sie nicht direkt in den main-Branch.
  • Führen Sie Seed-Skripte niemals auf Nicht-Lokalen Datenbanken aus.

Warum das funktioniert

Wenn Sie einem KI-Agenten eine Aufgabe wie „Füge einen DELETE-Endpunkt hinzu“ geben, liest er zuerst diese Datei.

Mit einer AGENTS.md-Datei kann der Agent:

  • Genau wissen, wo Code hinzugefügt werden muss.
  • Ihre spezifischen Test-Tools verwenden.
  • Ihrem Stil folgen, ohne Fragen zu stellen.
  • Einen Branch erstellen, anstatt Ihren Hauptcode zu beschädigen.

Ohne diese Datei rät der Agent. Er verwendet möglicherweise den falschen Test-Runner oder bearbeitet Dateien, die er nicht anfassen sollte.

Behandeln Sie diese Datei wie Code. Wenn sich Ihr Workflow ändert, aktualisieren Sie die Datei sofort. Eine veraltete Datei führt zu Fehlern.

Quelle: https://dev.to/wolfejam/agentsmd-hands-on-build-one-step-by-step-and-watch-an-agent-use-it-3g27

Optionale Lern-Community: https://t.me/GyaanSetuAi