KI-Integration
Blockstudio stellt zwei Kontextdateien für Programmierassistenten bereit. Die erste ist ein kompaktes Dokumentationsverzeichnis. Die zweite enthält den vollständigen Text aller Dokumente und Schemas für Tools, die den gesamten Bestand in einer Anfrage benötigen.
Ein Agent liest das Verzeichnis, findet das benötigte Dokument und öffnet es. Die Alternative wäre, einem Agenten eine halbe Megabyte undifferenzierten Text zu übergeben, in dem nichts gezielt auffindbar ist und alles geladen wird, unabhängig davon, ob es relevant ist.
Das Verzeichnis
blockstudio-llm.txt führt jedes veröffentlichte Dokument einmal auf, gruppiert nach dem jeweiligen Abschnitt und Unterabschnitt und in Navigationsreihenfolge. Jeder Eintrag enthält:
route: die Dokumentation URL.file: der Markdown Quellpfad im Blockstudio Repository.purpose: eine Zeile, die beschreibt, wozu das Dokument dient.settings: dieblockstudio.jsonPfade, für die das Dokument zuständig ist.hooks: die Namen der PHP- und JavaScript-Filter und -Aktionen, für die es zuständig ist.php: die Funktionen, Klassen und Methoden, für die es zuständig ist.cli: die Befehle, für die es zuständig ist.
## Docs / Dev / Inspection Tools
### Canvas
route: /docs/dev/canvas
file: docs/docs/dev/canvas.md
purpose: A visual workspace and public inventory API for Blockstudio content.
settings: dev/canvas/enabled, ui
hooks: blockstudio/settings/dev/canvas/admin_bar, blockstudio/settings/dev/canvas/enabled
php: Blockstudio\Canvas, Canvas::documents(), Canvas::inventory()
Eine Kennungszeile wird nur ausgegeben, wenn das Dokument tatsächlich etwas dieses Typs verwaltet. Der obige Eintrag enthält daher keine Zeile für cli, während die Seite zur statischen Vorabgenerierung die gesamte Befehlsfamilie für die Vorabgenerierung verwaltet.
Die Bezeichnerzeilen machen den Index durchsuchbar. Ein Agent, der den Hook sucht, der vor dem Rendern eines Blocks ausgelöst wird, durchsucht die Hook-Zeilen und findet PHP Hooks; dort ist das vollständige Vokabular der Filter und Aktionen aufgeführt. Wer nach statischem Prerendering sucht, findet über dasselbe Wort Static Prerendering und Settings; dort sind jeweils die Zähler und die Konfiguration aufgeführt. Die fünf öffentlichen JSON-Schemas sind ebenso mit ihrer Route und Datei aufgeführt.
Kennungen werden aus Fließtext, Inline-Code und Codebeispielen gelesen. Mit text markierte Blöcke enthalten wörtliche Ausgaben und Verzeichnisauflistungen und werden daher übersprungen: Ein Dokument, das die Ausgabe eines Befehls zeigt, ist deshalb nicht für diesen Befehl zuständig.
Der vollständige Text
blockstudio-llm-full.txt enthält die gesamte Dokumentation und jedes Schema in einer Datei. Sie wird weiterhin generiert, veröffentlicht und ist adressierbar. Ein Agent erhält sie jedoch nicht mehr als Erstes, und der eigene Kopfbereich weist darauf hin.
So werden sie erstellt
Beide Dateien werden zur Build-Zeit von npm run build:llm zusammengestellt, das scripts/build-llm.ts ausführt. Das Skript:
- Liest das Frontmatter jedes veröffentlichten Dokuments in den Sammlungen
docs,guidesundregistryaus, um Titel, Route und Zweck zu ermitteln. - Extrahiert aus dem Inhalt jedes Dokuments die zugehörigen Kennungen: Hook-Namen aus Filter- und Aktionsaufrufen, anhand des Einstellungsschemas validierte Einstellungspfade, PHP-Funktionen und -Klassen sowie CLI-Befehle.
- Schreibt das Verzeichnis nach
includes/llm/blockstudio-llm.txt. - Durchläuft den Dokumentationsbaum in Navigationsreihenfolge, entfernt ausschließlich der Navigation dienende Markdown, behält dabei Überschriften und Codebeispiele bei, fügt die JSON-Schemas an und schreibt den vollständigen Text nach
includes/llm/blockstudio-llm-full.txt.
npm run docs:check schlägt fehl, wenn ein veröffentlichtes Dokument im Verzeichnis fehlt oder das Verzeichnis auf eine nicht mehr vorhandene Datei verweist.
So verwendest du sie
- Aktiviere die Einstellung
ai/enableContextGenerationin deinemblockstudio.json:
{
"ai": {
"enableContextGeneration": true
}
}
-
Die Dateien sind jetzt unter
your-site.com/blockstudio-llm.txtundyour-site.com/blockstudio-llm-full.txtverfügbar. -
Verweise mit deinem KI-Tool auf das Verzeichnis:
- Cursor: Füge URL in den Projekteinstellungen als Dokument hinzu.
- Claude Code: Verweise auf URL oder lade die Datei herunter und füge sie zum Projektkontext hinzu.
- GitHub Copilot: Binde die Datei in dein Repository ein oder verweise in deinen Anweisungen darauf.
Jedes Tool, das eine URL- oder Textdatei als Kontext akzeptiert, funktioniert. Beide Dateien sind statisch und enthalten keine standortspezifischen Daten wie deine registrierten Blöcke oder aktuellen Einstellungen.
Der Vertrag für dein Projekt
Das Verzeichnis beschreibt Blockstudio. Es beschreibt nicht dein Projekt, also die andere Hälfte dessen, was ein Agent benötigt: wo sich Blöcke und Seiten befinden, welche Funktionen aktiviert sind und was bei der Analyse abgelehnt wird. vendor/bin/blockstudio-agents generiert diese Angaben aus deinem blockstudio.json und deinen eigenen Dateien. Weitere Informationen findest du im Projektvertrag.