For agents

vshaders publishes machine-readable surfaces and keeps this page honest about what works today and what does not.

Machine-readable surfaces

  • /llms.txt: the site summarized in the llms.txt convention.
  • /agents.md: status and capabilities, plain markdown.
  • /design.md: the visual system for building vshaders surfaces.
  • /r/registry.json: the shadcn-compatible registry index; items at /r/<name>.json.

What an agent can do today

Read this site: the docs, the effect sources, and the editor permalinks at /effects/<slug> are plain URLs. Add a complete effect with the shadcn CLI; all eleven effects (mesh-gradient, metaballs, palette-field, flow, ripple, dither, fluid, displacement, god-rays, heatmap, undertones) are installable:

npx shadcn@latest add https://vshaders.com/r/mesh-gradient.json

Install the module packages from npm. All five are published at 0.2.0:

npm install @vshaders/sdf @vshaders/color @vshaders/dither @vshaders/ease @vshaders/fluid

Validate any shader you generate or edit. Bundlers never validate WGSL, so this is the only gate:

npx vgpu check shaders/mesh-gradient.wgsl --require-validation

What is coming

  • Composition ids that carry tuned uniform values, installed with vshaders add <id>.
  • A read-only MCP endpoint for searching and fetching effects.

None of these exist yet. Until they ship, use the shadcn CLI and npm paths above, and see Add an effect for the full flow.