Integrácia AI
Blockstudio poskytuje dva kontextové súbory pre programátorské asistenty. Prvý je stručný index dokumentácie. Druhý obsahuje úplné znenie každého dokumentu a schémy, určené pre nástroje, ktoré chcú načítať celý súbor v jednej požiadavke.
Agent si prečíta index, nájde potrebný dokument a otvorí ho. Alternatívou je odovzdať agentovi pol megabajtu nerozlíšeného textu, v ktorom sa nedá nič adresovať a načíta sa všetko bez ohľadu na relevanciu.
Index
blockstudio-llm.txt uvádza každý publikovaný dokument raz, zoskupený podľa
sekcie a podsekcie, do ktorej patrí, v poradí navigácie. Každá položka obsahuje:
route: URL dokumentácie.file: zdrojovú cestu Markdown v repozitári Blockstudio.purpose: jeden riadok opisujúci účel dokumentu.settings: cestyblockstudio.json, ktoré dokument spravuje.hooks: názvy filtrov a akcií PHP a JavaScript, ktoré spravuje.php: funkcie, triedy a metódy, ktoré spravuje.cli: príkazy, ktoré spravuje.
## 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()
Riadok identifikátora sa uvádza len vtedy, keď dokument skutočne spravuje niečo daného druhu. Preto vyššie uvedená položka nemá riadok cli, zatiaľ čo stránka statického predvykresľovania spravuje celú rodinu príkazov na predvykresľovanie.
Riadky identifikátorov umožňujú vyhľadávať v indexe. Agent hľadajúci hák, ktorý sa spustí pred vykreslením bloku, prehľadá riadky hákov a nájde PHP Háky, ktoré spravujú kompletnú slovnú zásobu filtrov a akcií. Agent hľadajúci statické predvykresľovanie vyhľadá rovnaký výraz a nájde Statické predvykresľovanie a Nastavenia, ktoré spravujú počítadlá, respektíve konfiguráciu. Rovnakým spôsobom je uvedených aj päť verejných schém JSON spolu s ich trasou a súborom.
Identifikátory sa načítavajú z prózy, vloženého kódu a ukážok kódu. Bloky označené text obsahujú doslovný výstup a zoznamy adresárov, preto sa preskakujú: dokument, ktorý vypíše výstup príkazu, tým tento príkaz nespravuje.
Úplný text
blockstudio-llm-full.txt obsahuje úplnú dokumentáciu a všetky schémy v jednom
súbore. Stále sa generuje, publikuje a dá sa adresovať, no agentovi sa už neponúka ako prvý súbor a uvádza to aj jeho vlastná hlavička.
Ako sa vytvárajú
Oba súbory sa zostavujú pri zostavení pomocou npm run build:llm, ktorý spúšťa
scripts/build-llm.ts. Skript:
- Načíta frontmatter každého publikovaného dokumentu v kolekciách
docs,guidesaregistry, aby získal jeho názov, trasu a účel. - Z tela každého dokumentu extrahuje identifikátory, ktoré spravuje: názvy hákov z volaní filtrov a akcií, cesty nastavení overené voči schéme nastavení, funkcie a triedy PHP a príkazy CLI.
- Zapíše index do
includes/llm/blockstudio-llm.txt. - Prejde strom dokumentácie v poradí navigácie, odstráni navigačné Markdown
a zachová nadpisy a ukážky kódu, pridá schémy JSON a zapíše celý text do
includes/llm/blockstudio-llm-full.txt.
npm run docs:check zlyhá, ak v indexe chýba publikovaný dokument
alebo ak index odkazuje na súbor, ktorý už neexistuje.
Ako ich používať
- Povoľte nastavenie
ai/enableContextGenerationvo svojomblockstudio.json:
{
"ai": {
"enableContextGeneration": true
}
}
-
Súbory sú teraz dostupné na adresách
your-site.com/blockstudio-llm.txtayour-site.com/blockstudio-llm-full.txt. -
Nasmerujte svoj nástroj AI na index:
- Cursor: pridajte URL ako dokument v nastaveniach projektu.
- Claude Code: odkážte na URL alebo stiahnite súbor a pridajte ho do kontextu projektu.
- GitHub Copilot: zahrňte súbor do svojho repozitára alebo sa naň odvolajte v pokynoch.
Funguje každý nástroj, ktorý prijíma URL alebo textový súbor ako kontext. Oba súbory sú statické a neobsahujú údaje špecifické pre danú stránku, ako sú vaše registrované bloky alebo aktuálne nastavenia.
Kontrakt vášho projektu
Index opisuje Blockstudio. Neopisuje váš projekt, ktorý predstavuje druhú polovicu informácií potrebných pre agenta: kde sa nachádzajú bloky a stránky, ktoré funkcie sú povolené a čo analýza odmietne. vendor/bin/blockstudio-agents to generuje z vášho blockstudio.json a vlastných súborov. Pozrite si kontrakt projektu.