Use sv-grid docs as LLM context
This page is the "how do I make ChatGPT / Claude / Cursor write good sv-grid code?" guide. Three pre-built artefacts ship with the docs specifically so models can ground themselves in current, accurate information instead of hallucinating from training data.
The four files
| File | Format | Size | Use for |
|---|---|---|---|
/llms.txt |
Plain text | ~10 kB | First-pass context: the topic map with one-line summaries |
/llms-full.txt |
Plain text | ~700 kB | Deep grounding: every doc page concatenated |
/docs.json |
JSON | ~80 kB | Programmatic crawling: section tree, per-page metadata, demo links |
/schemas/index.json |
JSON | ~30 kB | Validation: machine-checkable shape of ColumnDef, <SvGrid> props, export options |
All four are regenerated on every commit by tools/build-docs-index.mjs
and tools/build-schemas.mjs. They live at the docs origin
(https://svgrid.com/...) so you can fetch them at runtime.
Recipe 1: Drop into a custom GPT / Claude project
The simplest way. Both ChatGPT (custom GPTs) and Claude (projects) let you upload reference files that ride along with every chat.
- Save
/llms-full.txtlocally. - In ChatGPT: Create custom GPT → Configure → Knowledge → Upload files.
- In Claude: Project → Project knowledge → Add document.
- Add this system instruction:
You are a sv-grid expert. Ground every answer in the attached
llms-full.txt. If a question references an API not in the document,
say so and ask the user to upgrade rather than inventing one. Prefer
the smallest working example. When showing columns, follow the
column-def.json schema exactly.
- (Optional) Upload
column-def.jsonandsvgrid-options.jsonalongside so the model can self-check generated config.
That's it. The next time you ask "how do I export only selected rows to xlsx?" the model answers from the doc text, not from its year-old training cutoff.
Recipe 2: Cursor / Continue / Cody rules file
Most IDE assistants honour a .cursorrules / .continuerules /
.aider.conf.yml file in the repo root. Drop in:
# .cursorrules
When generating sv-grid code:
- Read context from https://svgrid.com/llms.txt before answering.
- For column definitions, generate against
https://svgrid.com/schemas/column-def.json (Draft 2020-12 JSON Schema).
- Use Svelte 5 runes ($state, $derived, $effect) - never legacy stores.
- Use `editorType: 'list'` with `editorOptions` for dropdowns,
not raw <select> elements.
- Always type the grid as
`SvGrid<typeof features, RowType>` so column inference works.
- The two npm packages are `sv-grid-community` (MIT) and `sv-grid-pro`
(commercial). Never import from `@sv-grid/core` or `svelte-grid`,
which are different projects.
Recipe 3: Programmatic grounding in your own agent
If you're building a custom agent (OpenAI Agents SDK, Anthropic SDK, LangChain, custom), fetch the docs once at boot:
const [topicMap, schemas] = await Promise.all([
fetch('https://svgrid.com/llms.txt').then((r) => r.text()),
fetch('https://svgrid.com/schemas/index.json').then((r) => r.json()),
])
const systemPrompt = `You write Svelte 5 code that uses sv-grid.
DOCS INDEX (use these URLs to look up specifics):
${topicMap}
SCHEMAS available for validation:
${JSON.stringify(schemas, null, 2)}
For deep API questions, fetch https://svgrid.com/llms-full.txt or
the specific page from the index above.`
Now hand the model a tool that can fetch arbitrary /docs.json paths
on demand, and it can answer any sv-grid question with current data.
Recipe 4: MCP server (best for daily-driver chat)
If your workflow centers on Claude Desktop / Cursor / Zed, the
MCP server is the single line of config that
exposes all four files PLUS callable tools (scaffoldColumns,
validateColumns, previewExport). Skip Recipes 1-3 and use the
MCP server instead.
What's IN the grounding files
Every file is exhaustive but tightly scoped to sv-grid surface area:
- API surface: every prop on
<SvGrid>, every method onSvGridApi, every field onColumnDef - Features: when to use sorting / filtering / grouping / pagination feature toggles, and the trade-offs
- Pro tier: export, import, pivot, AI helpers - each documented as if it were free, with the licensing call-out at the top of the page
- Recipes: 25+ copy-paste patterns from the cookbook
- Migrations: how to translate AG Grid / TanStack Table / MUI X DataGrid / Handsontable / Glide concepts
- Errors: every typed error the library throws, with the trigger and the fix
What's NOT in the grounding files
- Internal implementation: virtualizer math, headless engine pipeline internals - not part of the public surface
- Future / roadmap: deliberately excluded so the model never confuses ambition with reality
- CSS class hashes: Svelte mangles class names. The
--sg-*tokens are stable and documented; the class names are not.
Keeping the grounding fresh
Re-fetch on every model turn for chat tools; cache for ~24h for
agent loops. The docs are versioned - if you pin to a specific
version, append a ?v=1.6.0 query string when fetching from the
origin (rejected if the major changes; we serve a 410).
See also
- MCP server - the easiest way to wire all this in
- Agents - building an agent that DRIVES the grid (not just describes it)
- API stability - what we promise to keep stable across versions