Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt

Use this file to discover all available pages before exploring further.

AGENTS.md-Dateien bieten eine einfache Möglichkeit, Cascade kontextabhängige Anweisungen zu geben, die automatisch gelten, je nachdem, wo sich die Datei in Ihrem Projekt befindet. Das ist besonders nützlich, um verzeichnisspezifische Codierrichtlinien, Architekturentscheidungen oder Projektkonventionen festzulegen.

Wie es funktioniert

Wenn Sie eine AGENTS.md-Datei (oder agents.md) erstellen, erkennt Devin Desktop sie automatisch und übergibt sie an dieselbe Rules-Engine, die auch .windsurf/rules/ verwendet — nur dass der Aktivierungsmodus hier anhand des Dateispeicherorts statt über frontmatter bestimmt wird:
  • Stammverzeichnis: Wird als immer aktiv-Regel behandelt — der vollständige Inhalt wird bei jeder Nachricht in den System-Prompt von Cascade aufgenommen.
  • Unterverzeichnisse: Werden als glob-Regel mit einem automatisch generierten Muster <directory>/** behandelt — der Inhalt wird nur angewendet, wenn Cascade Dateien in diesem Verzeichnis liest oder bearbeitet.
Diese standortbasierte Eingrenzung macht AGENTS.md ideal, um gezielte Hinweise bereitzustellen, ohne eine einzelne globale Konfigurationsdatei zu überladen.

Eine AGENTS.md-Datei erstellen

Erstellen Sie einfach eine Datei namens AGENTS.md oder agents.md im gewünschten Verzeichnis. Die Datei verwendet einfaches Markdown; spezielles Frontmatter ist nicht erforderlich.

Beispielstruktur

my-project/
├── AGENTS.md                    # Globale Anweisungen für das gesamte Projekt
├── frontend/
│   ├── AGENTS.md                # Anweisungen spezifisch für Frontend-Code
│   └── src/
│       └── components/
│           └── AGENTS.md        # Anweisungen spezifisch für Komponenten
├── backend/
│   └── AGENTS.md                # Anweisungen spezifisch für Backend-Code
└── docs/
    └── AGENTS.md                # Anweisungen für die Documentation

Beispielinhalt

Hier ist eine Beispiel-AGENTS.md-Datei für ein Verzeichnis mit React-Komponenten:
# Komponenten-Richtlinien

Beim Arbeiten mit Komponenten in diesem Verzeichnis:

- Funktionale Komponenten mit Hooks verwenden
- Namenskonvention einhalten: ComponentName.tsx für Komponenten, useHookName.ts für Hooks
- Jede Komponente sollte eine entsprechende Testdatei haben: ComponentName.test.tsx
- CSS-Module für das Styling verwenden: ComponentName.module.css
- Komponenten als benannte Exporte exportieren, nicht als Standard-Exporte

## Dateistruktur

Jeder Komponentenordner sollte enthalten:
- Die Haupt-Komponentendatei
- Eine Testdatei
- Eine Styles-Datei (falls erforderlich)
- Eine index.ts für Re-Exporte

Erkennung und Geltungsbereich

Devin Desktop erkennt AGENTS.md-Dateien automatisch in Ihrem gesamten Workspace:
  • Workspace-Scan: Alle AGENTS.md-Dateien in Ihrem Workspace und seinen Unterverzeichnissen werden erkannt
  • Git-Repository-Unterstützung: Bei Git-Repositories durchsucht Devin Desktop außerdem übergeordnete Verzeichnisse bis zum Git-Root
  • Groß-/Kleinschreibung wird nicht beachtet: Sowohl AGENTS.md als auch agents.md werden erkannt

Automatische Festlegung des Geltungsbereichs

Der Hauptvorteil von AGENTS.md ist die automatische Festlegung des Geltungsbereichs anhand des Dateispeicherorts:
DateispeicherortGeltungsbereich
Workspace-StammverzeichnisGilt für alle Dateien (immer aktiv)
/frontend/Gilt bei der Arbeit mit Dateien in /frontend/**
/frontend/components/Gilt bei der Arbeit mit Dateien in /frontend/components/**
Das bedeutet, dass Sie mehrere AGENTS.md-Dateien auf verschiedenen Ebenen haben können, die jeweils immer spezifischere Hinweise für die entsprechenden Verzeichnisse geben.

Bewährte Vorgehensweisen

So holen Sie das Beste aus AGENTS.md-Dateien heraus:
  • Halten Sie Anweisungen gezielt: Jede AGENTS.md sollte Anweisungen enthalten, die für den Zweck ihres Verzeichnisses relevant sind.
  • Verwenden Sie eine klare Struktur: Aufzählungspunkte, Überschriften und Codeblöcke erleichtern es Cascade, Anweisungen zu befolgen.
  • Seien Sie präzise: Konkrete Beispiele und klare Konventionen funktionieren besser als vage Richtlinien.
  • Vermeiden Sie Redundanzen: Wiederholen Sie keine globalen Anweisungen in Dateien von Unterverzeichnissen; diese werden aus übergeordneten Verzeichnissen übernommen.

Inhaltsrichtlinien

# Good Example
- Use TypeScript strict mode
- All API responses must include error handling
- Follow REST naming conventions for endpoints

# Less Effective Example
- Write good code
- Be careful with errors
- Use best practices

Vergleich mit Rules

Sowohl AGENTS.md als auch Rules geben Cascade Anweisungen, dienen jedoch unterschiedlichen Zwecken:
MerkmalAGENTS.mdRules
SpeicherortIn Projektverzeichnissen.windsurf/rules/ oder global
GeltungsbereichAutomatisch anhand des DateispeicherortsManuell (glob, immer aktiv, model decision, manual)
FormatReines MarkdownMarkdown mit Frontmatter
Am besten geeignet fürVerzeichnisspezifische KonventionenÜbergreifende Aspekte, komplexe Aktivierungslogik
Verwende AGENTS.md, wenn du einfache, speicherortbasierte Anweisungen möchtest. Verwende Rules, wenn du mehr Kontrolle darüber brauchst, wann und wie Anweisungen angewendet werden.