KI-Codieragenten & AGENTS.md
KI-Codingassistenten – Claude, GitHub Copilot, Cursor und andere – können ein PowerPortalsPro-Portal viel genauer bauen und anpassen, wenn sie die Konventionen des Frameworks verstehen. Um das automatisch zu machen, liefert jedes Projekt, das aus einer PowerPortalsPro-Vorlage generiert wird, eine AGENTS.md Datei an der Wurzel aus.
Was ist AGENTS.md?
AGENTS.md ist eine einfache Markdown-Anweisungsdatei, die KI-Coding-Tools automatisch lesen, um die Konventionen eines Projekts zu lernen, bevor sie Code schreiben. Es handelt sich um einen aufkommenden Cross-Tool-Standard – dieselbe Datei wird von Claude, GitHub Copilot, Cursor und anderen übernommen – sodass man eine Anleitung pflegt, nicht pro Werkzeug. Die PowerPortalsPro-Vorlagen erzeugen eine auf das Framework zugeschnittene Struktur AGENTS.md , sodass ein Agent weiß, wie er Funktionen aus Framework-Komponenten und -diensten zusammenstellen muss, anstatt manuell Datenzugriff, Authentifizierung oder Speicherlogik zu übernehmen.
Anmerkung
Die Anleitung ist stack-spezifisch: Ein Projekt, das aus der React-Vorlage generiert wird, liefert ein React-fokussiertes
AGENTS.mdProjekt aus, und ein Blazor-Projekt liefert ein Blazor-fokussiertes. Jede beschreibt die Komponenten, Services und Muster für diesen Stack.
Wo es lebt
Die Datei befindet sich am Root deiner generierten Lösung, zusammen mit deinen Projekten, sodass jedes KI-Tool, das im Repository geöffnet wird, sie ohne Konfiguration findet:
YourPortal/
├── AGENTS.md
├── YourPortal/ (host / ASP.NET Core project)
└── YourPortal.Client/ (your pages, components, customizations)
Was ist drin
Die generierten AGENTS.md Konventionen destillieren die Konventionen, die diese Dokumentationsseite abdeckt, in eine immer-kontextbezogene Referenz, die ein Agent bei jeder Aufgabe liest:
- Goldene Regeln – Datenzugriff, Authentifizierung oder Speicherlogik nicht manuell übertragen; Editoren an einen Datensatzkontext binden; Niemals fest kodieren Sie Farben oder benutzerorientierte Strings.
- Architektur & Projektlayout – wie die Host- und Kundenprojekte zusammenpassen und wo sich Ihre Seiten und Komponenten befinden.
- Daten- und Bearbeitungsmuster – Laden von Datensätzen, dem Datensatzkontext + Feldeditor-Modell sowie den Gitterkomponenten.
- Eine kompakte Komponentenreferenz – die Requisiten/Parameter für die Komponenten, die du am meisten benutzt, mit Zeigern auf Typen und IntelliSense für den Rest.
- Sicherheit – Filterung der Daten an der Quelle für genaue Auslagerung und Leistung; Permission-Handler sind die Durchsetzungsebene.
- Lokalisierung & Theming – die String-Key-Konventionen und Design-Token-Regeln.
- Dev-Workflow & Gotchas – wie man das Projekt durchführt und welche Fehler man vermeiden sollte.
Sie effektiv nutzen
Ein paar Gewohnheiten holen Sie das Beste aus dem Leitfaden heraus:
- Lass den Agenten es zuerst lesen. Die meisten Werkzeuge laden
AGENTS.mdautomatisch; wenn nicht, zeigen Sie Ihren Assistenten darauf hin, bevor Sie nach einer Funktion fragen. - Stütze dich auf Types und IntelliSense. Der Leitfaden ist bewusst prägnant – für die gesamte Oberfläche jeder Komponente oder eines Dienstes kann der Agent die TypeScript-Definitionen (React) oder XML-doc IntelliSense (Blazor) lesen.
- Beziehen Sie sich auf diese Seite. Weise den Agenten auf die Live-Beispiele und API-Referenzen hier in der Demo auf Muster, die er kopieren kann.
- Überprüfen Sie die Ergebnisse. Der Leitfaden macht einen Agenten genauer, ersetzt aber nicht Ihre Bewertung – insbesondere die erstellten Sicherheitsregeln und Datenfilterung.
Zum Beispiel gibt eine solche Anfrage einem Agenten alles, was er braucht, um idiomatischen Code zu erstellen:
Fügen Sie eine Seite hinzu, die ppp_widget Datensätze in einem MainGrid auflistet, und ermöglicht es dem Benutzer, einen zu öffnen, um ihn in einem RecordContext-Formular zu bearbeiten. Halte dich an die Konventionen in AGENTS.md und stelle sicher, dass Widgets auf den aktuellen Nutzer gefiltert sind.
Mach ihn zu deinem
AGENTS.md ist eine gewöhnliche Datei in deinem Repository – bearbeite sie. Füge eigene Tabellen und Beziehungen, Domänenregeln, Namenskonventionen und projektspezifische Muster hinzu, damit der Agent dein Portal und nicht nur das Framework lernt. Je besser die Datei deine Codebasis widerspiegelt, desto besser ist der generierte Code.
Tipp
Behandle
AGENTS.mdes als lebende Dokumentation: Wenn du eine neue Konvention etablierst oder einen wiederkehrenden Fehler bemerkst, füge eine Zeile in die Datei ein, damit jede zukünftige KI-Sitzung davon profitiert.
