Docs for AI agents
What this documentation offers an AI agent, and how to use each one.
Overview
QVAC docs offers AI agents the following:
llms.txt— an index of what is published and where to fetch itllms-full.txt— the full text of the documentation in one fetch- Ask AI chat — an assistant that answers from these pages
- Markdown negotiation — any page as plain Markdown
- MCP server — these docs as a tool your editor can call
The SDK and the CLI publish one copy of their documentation per release, which changes how you use most of the above. Read Versioning before you rely on an answer about either.
llms.txt
An index. It tells you what is published and where to fetch it, so you can read one thing instead of everything.
There is one at each of three levels:
| Fetch | To get |
|---|---|
/llms.txt | Every collection on the site, and where to resolve the versioned ones |
/{collection}/llms.txt | Every published line of one collection, with each line's index and corpus |
/{collection}/v{major}.{minor}/llms.txt | Every page of one line |
Start at /llms.txt. It is small, and it names where to go next.
For a versioned collection, /{collection}/versions.json carries what that
collection's llms.txt carries, as JSON. Fetch that one if you are parsing
rather than reading.
llms-full.txt
The full text of many pages in one fetch. Use it when you need broad context and do not yet know which page holds the answer. Use a single page when you do.
The same three levels:
| Fetch | To get |
|---|---|
/llms-full.txt | The unversioned collections, plus the current line of every versioned one |
/{collection}/llms-full.txt | The current line of that collection |
/{collection}/v{major}.{minor}/llms-full.txt | That line |
Every corpus opens with a header naming what is in it, how many pages it holds, and where to go for what it leaves out. Read the header — it is how you find out you fetched the wrong scope.
Release notes are withheld from every corpus. Fetch one as its own page, from that line's index.
If you are answering about a specific release, fetch that line's corpus. The site corpus carries only current lines.
Ask AI chat
An assistant that answers from this documentation and cites the pages it used. Use it when you do not know the term to search for.
Press Cmd + I (Ctrl + I on Windows and Linux), or click Ask AI in the
header.
It searches the line you are reading, the unversioned collections, and the current line of every other versioned collection. It will not answer from a line you are not in, so open a page of the line you care about first.
Markdown negotiation
Every page is also published as Markdown, without the site around it. Use it to hand a page to a model.
There are two ways to get it:
- Append
.mdto the path —/sdk/js-ts-sdkbecomes/sdk/js-ts-sdk.md. - Send
Accept: text/markdown— any page URL redirects to its Markdown. Use this when you cannot rewrite the URL.
Each Markdown page opens with front matter naming its collection, the package
that collection tracks, its line, and whether that line is the current one.
Check line and current_line to confirm you have the release you meant.
Cite the URL without .md. That is the one a person can open.
On a page you are reading, Copy page copies its Markdown, and the button beside it opens the page in ChatGPT or Claude.
MCP server
A Model Context Protocol server, so an MCP-capable editor or agent can search these docs as a tool instead of fetching URLs.
Add this endpoint to your client:
https://mcp.inkeep.com/tetherio/mcpThe For AI menu in the header copies that address for you.
Versioning
The SDK and the CLI each publish one complete copy of their documentation per release — a documentation line. A line is self-contained, so reading the wrong one gives you answers that are internally consistent and wrong for the project in front of you.
Resolve the line before you read
- Read the installed version from the project, not from this site:
package.jsonand the lockfile for@qvac/sdkor@qvac/cli. Keep the major and minor, drop the patch —0.16.3isv0.16. - Fetch
/{collection}/versions.json. It names every published line and marks which one is current. - Take the line whose
versionmatches. Read itsindexfor a page list, or itscorpusfor the whole line in one fetch.
If you are a person rather than an agent, skip all three: use the version switcher at the top of the sidebar.
The current line carries no version in its URL
The current line is served at /sdk/…; every older line carries its own
segment, /sdk/v0.19/…. Cite the URL of the line you actually read.
When no line matches
Only the most recent releases stay published, so a project pinned further back will find no line of its own.
- Read the nearest older line — the highest published version below the one installed.
- Say which line you read and which release the project is on, so the reader can judge the gap.
- Never fall forward to a newer line. It describes behaviour the installed release may not have.
Never mix lines
Do not combine text from two lines of the same collection in one answer. Their APIs differ; that is why they are separate.
Combining collections is fine. The SDK and the CLI are versioned independently — resolve each at its own line.