AI assistants

An assistant that has never seen BlinkBlox will write schemas in some other IDL’s syntax, or in upstream Blink’s, and guess at option names. Give it these docs instead. The site publishes them as plain text files, following the llms.txt convention, rebuilt with every change to the site:

File	Contents	Use it when
`llms.txt`	A short index pointing at the two files below.	The tool asks for an `llms.txt` URL.
`llms-full.txt`	Every page of this site, in one Markdown file.	You want the assistant to have everything: the language, the guides, every option and diagnostic.
`llms-small.txt`	The same pages with notes, collapsible sections and extra whitespace removed.	The context window is tight.

Claude Code

Tell Claude Code where the docs are in your project’s CLAUDE.md, so every session starts knowing:

## Networking

Networking is generated by BlinkBlox from `src/network.blink`. Never edit the generated
`Server.luau` / `Client.luau`; change the schema and recompile with `blinkblox src/network.blink`.

BlinkBlox documentation: https://xopoiii.github.io/BlinkBlox/llms-full.txt
Fetch it before writing or changing a schema.

Claude Code fetches the URL when a task needs it. To have the docs in context without a fetch, save a copy into the repository and import it from CLAUDE.md with @:

curl -o docs/blinkblox.md https://xopoiii.github.io/BlinkBlox/llms-full.txt

@docs/blinkblox.md

A saved copy does not update itself. Fetch it again when you upgrade the compiler.

Cursor

Add the docs as a custom documentation source: in Cursor’s settings, under the documentation section, add https://xopoiii.github.io/BlinkBlox/llms-full.txt, then reference it with @Docs in a chat. Alternatively, save the file into the project as above and mention it with @ like any other file, or point a project rule at it.

Other assistants

Anything that can read a URL or a file works the same way: paste the llms-full.txt link, or attach the file. For an assistant with a small context window, use llms-small.txt.

Checking its work

Whatever the assistant, have it check the schema after changing it. The compiler’s diagnostics name the rule and the fix (see Diagnostics), and an assistant that reads them corrects its own mistakes far more reliably than one working from memory.

blinkblox src/network.blink --check --json

--check runs the whole compile without touching the generated modules, and --json reports each diagnostic with its code, file, line and column, its labels and its notes, as one JSON document an assistant can read without picking through box-drawing characters. The exit code says whether the schema compiles. Put the command in CLAUDE.md or a project rule next to the documentation link:

After changing `src/network.blink`, run `blinkblox src/network.blink --check --json` and fix every
error and warning it reports before recompiling.

There is no MCP server for BlinkBlox, and none is planned: an assistant that can run a command gets everything such a server would offer from the command above and from llms-full.txt.