Přejít k obsahu

Integrace AI

Blockstudio obsahuje dva kontextové soubory pro asistenty při programování. První je stručný index dokumentace. Druhý obsahuje úplný text všech dokumentů a schémat pro nástroje, které chtějí načíst celý souborový korpus v jediném požadavku.

Agent si přečte index, najde potřebný dokument a otevře ho. Alternativou je předat agentovi půl megabajtu neuspořádaného textu, ve kterém nelze nic přímo najít a načítá se vše bez ohledu na relevanci.

Index

blockstudio-llm.txt uvádí každý publikovaný dokument právě jednou, seskupený podle příslušné sekce a podsekce v pořadí navigace. Každá položka obsahuje:

  • route: URL dokumentace.
  • file: zdrojovou cestu Markdown v repozitáři Blockstudio.
  • purpose: řádek popisující účel dokumentu.
  • settings: cesty blockstudio.json, za které dokument odpovídá.
  • hooks: názvy filtrů a akcí PHP a JavaScript, za které dokument odpovídá.
  • php: funkce, třídy a metody, za které dokument odpovídá.
  • cli: příkazy, za které dokument odpovídá.
Text
## 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()

Řádek s identifikátory se zapíše pouze tehdy, když dokument skutečně něco daného druhu spravuje. Výše uvedená položka proto nemá řádek cli, zatímco stránka statického předběžného vykreslování spravuje celou rodinu příkazů pro předběžné vykreslování.

Řádky s identifikátory umožňují v indexu vyhledávat. Agent, který hledá hook spouštěný před vykreslením bloku, prohledá řádky s hooky a najde PHP Hooks, kde jsou uvedeny všechny filtry a akce. Agent, který hledá statické předvykreslování, vyhledá stejný výraz a najde Static Prerendering a Settings, kde jsou uvedeny počítadla a konfigurace. Stejným způsobem je uvedeno pět veřejných schémat JSON spolu s jejich trasou a souborem.

Identifikátory se načítají z běžného textu, vloženého kódu a ukázek kódu. Bloky označené text obsahují doslovný výstup a výpisy adresářů, proto se přeskakují: dokument, který vypisuje výstup příkazu, tím daný příkaz nespravuje.

Úplný text

blockstudio-llm-full.txt obsahuje v jednom souboru úplnou dokumentaci i všechna schémata. Stále se generuje, publikuje a lze na něj přímo odkazovat, ale agent už ho nedostává jako první; upozorňuje na to i jeho vlastní záhlaví.

Jak se vytvářejí

Oba soubory vytváří při sestavení npm run build:llm, který spouští scripts/build-llm.ts. Skript:

  1. Načte frontmatter každého publikovaného dokumentu ze sbírek docs, guides a registry, aby získal jeho název, trasu a účel.
  2. Z těla každého dokumentu extrahuje identifikátory, za které dokument odpovídá: názvy hooků z volání filtrů a akcí, cesty nastavení ověřené proti schématu nastavení, funkce a třídy PHP a příkazy CLI.
  3. Zapíše index do includes/llm/blockstudio-llm.txt.
  4. Projde strom dokumentace v pořadí navigace, odstraní Markdown určené pouze pro navigaci a zachová nadpisy i ukázky kódu, připojí schémata JSON a zapíše úplný text do includes/llm/blockstudio-llm-full.txt.

npm run docs:check selže, pokud v indexu chybí publikovaný dokument nebo pokud index odkazuje na soubor, který už neexistuje.

Jak je používat

  1. Povolte nastavení ai/enableContextGeneration ve svém blockstudio.json:
JSON
{
  "ai": {
    "enableContextGeneration": true
  }
}
  1. Soubory jsou nyní dostupné na adresách your-site.com/blockstudio-llm.txt a your-site.com/blockstudio-llm-full.txt.

  2. Nastavte svůj nástroj AI, aby používal index:

    • Cursor: přidejte URL jako dokument do nastavení projektu.
    • Claude Code: odkažte na URL nebo soubor stáhněte a přidejte do kontextu projektu.
    • GitHub Copilot: vložte soubor do repozitáře nebo na něj odkažte v pokynech.

Funguje jakýkoli nástroj, který přijímá jako kontext URL nebo textový soubor. Oba soubory jsou statické a neobsahují data specifická pro daný web, jako jsou zaregistrované bloky nebo aktuální nastavení.

Vlastní popis rozhraní projektu

Index popisuje Blockstudio. Nepopisuje však váš projekt, tedy druhou část informací, které agent potřebuje: kde se nacházejí bloky a stránky, které funkce jsou povolené a co analýza odmítne. vendor/bin/blockstudio-agents tyto informace generuje z vašeho blockstudio.json a vlastních souborů. Viz popis rozhraní projektu.