Spree Commerce developer docs for AI agents
RemoteAbout Spree Commerce developer docs for AI agents
Documentation for developers and coding agents building headless B2B and marketplace ecommerce with Spree Commerce APIs. The docs use Mintlify and can be run locally.
Key features
- 01Spree Commerce API documentation
- 02Guidance for coding agents
- 03Mintlify documentation build
- 04Local preview support
Use cases
- 01Look up Spree Commerce APIs
- 02Reference docs during ecommerce development
Configuration
Remote servers need no local install. Pick your client, then copy the config or install in one click.
https://spreecommerce.org/docs/mcpclaude mcp add --transport http spree-ecommerce-docs https://spreecommerce.org/docs/mcp{"mcpServers":{"spree-ecommerce-docs":{"type":"http","url":"https://spreecommerce.org/docs/mcp"}}}Open in Cursor{"servers":{"spree-ecommerce-docs":{"type":"http","url":"https://spreecommerce.org/docs/mcp"}}}Open in VS Code{"mcpServers":{"spree-ecommerce-docs":{"type":"http","url":"https://spreecommerce.org/docs/mcp"}}}{"mcpServers":{"spree-ecommerce-docs":{"serverUrl":"https://spreecommerce.org/docs/mcp"}}}Run commands in a terminal; paste JSON into the client’s MCP config and restart. Servers that need sign-in will prompt on first connect.
Tools
Details
From the project READMESpree Commerce Documentation project
This directory contains the documentation for Spree Commerce located at https://spreecommerce.org/docs.
Contributing
We welcome contributions to the documentation! We use Mintlify to build the documentation.
To run the documentation locally, you will need to install the Mintlify CLI.
Important
Mintlify requires Node.js version 20+ to run.
npm i -g mint
Then you can run the documentation locally. From the repository root:
pnpm docs:dev
This serves the documentation at http://localhost:3333.
The port is pinned deliberately. Running mint dev on its own picks port 3000 and silently moves to 3001, 3002 and so on when that is taken — which, in a checkout that also runs a Rails server and a dashboard, means the docs land somewhere different each time. If you do run mint dev directly, pass the port yourself:
cd docs && mint dev --port 3333
License
Documentation located in this directory is licensed under the CC BY 4.0 license.
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.