Skip to main content
Beyond the MCP server, the Spree documentation is published in formats designed for direct LLM consumption. Use these when you want to feed docs into a prompt, point a custom agent at an index, or give agents fast local file access.

llms.txt

Following the llms.txt convention, two indexes are published:

Per-page Markdown

Append .md to any docs URL to get the raw Markdown for that page — ideal for fetching a single authoritative page into context:

The @spree/docs npm package

The full developer documentation also ships as an npm package, so agents working in your repository can Read doc files locally — no network round-trips, works offline, and version-pinned to what you installed:
Projects scaffolded with create-spree-app install it automatically.
The package carries the Spree version: @spree/docs@6.0.4 is the documentation for Spree 6.0.4. create-spree-app projects depend on the Spree major (^6.0.0-0), and spree upgrade moves the package along with the server. Prefer the MCP server when you need docs for a newer Spree than your project runs.

Generated agent instructions

create-spree-app scaffolds every project with an AGENTS.md that tells coding agents where the local docs live, how to inspect live data with spree api, and that every command goes through the Spree CLI — spree migrate, spree console, spree test — never bin/rails, bundle or rake directly. server/AGENTS.md adds the customization patterns to follow. Each directory also has a CLAUDE.md that imports its AGENTS.md, so Claude Code reads the same instructions as every other agent. The scaffold also installs the agent skills unless you opt out.