Spree Commerce developer docs for AI agents

io.github.spreePublished by GitHub account spreev1.0.0Updated Nov 7, 2026

Spree Commerce docs for AI coding agents: build headless B2B and marketplace ecommerce on its APIs.

VerifiedStreamable HTTPWeb executableKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

Remote MCP server that lets an assistant search Spree Commerce documentation and query its docs filesystem to answer ecommerce development questions.

What you can do
  • Search the Spree Commerce documentation knowledge base for guides, API references and code examples
  • Run read-only shell-like queries against a virtual in-memory filesystem of documentation pages and OpenAPI specs
  • Report documentation problems, such as incorrect, outdated or incomplete pages, to the docs team
When to use it
Useful when building headless B2B or marketplace ecommerce on Spree Commerce APIs and you want answers grounded in the official documentation rather than model memory. Also handy for locating specific guides, API references or OpenAPI specs.
Requirements
A remote streamable HTTP endpoint at spreecommerce.org; no package, account, API key or environment variable is declared. Network access to the site is needed.
Before you install
The submit_feedback tool sends content to the documentation team, so avoid including secrets or private details in feedback. Apart from that the server is described as read-only and limited to published documentation; it does not grant access to private or authenticated content.

Installation

In SourceWeft

  1. Open Spree Commerce developer docs for AI agents in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/io.github.spree%2Fecommerce-docs/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "mcpServers": {
    "spree-commerce-developer-docs-for-ai-age": {
      "type": "http",
      "url": "https://spreecommerce.org/docs/mcp"
    }
  }
}

README

Spree 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.

bash
npm i -g mint

Then you can run the documentation locally. From the repository root:

bash
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:

bash
cd docs && mint dev --port 3333

License

Documentation located in this directory is licensed under the CC BY 4.0 license.

Source: docs/README.md at commit 4cfb2ab

Tools

3

search_spree_commerce_documentation

Search documentation

Search across the Spree Commerce documentation knowledge base to find relevant information, code examples, API references, and guides. Use this tool when you need to answer questions about Spree Commerce documentation, find specific documentation, understand how features work, or locate implementation details. The search returns contextual content with titles and direct links to the documentation pages. If you need the full content of a specific page, use the query_docs_filesystem tool to `head` or `cat` the page path (append `.mdx` to the path returned from search — e.g. a result at `/some/page` is read with `head -200 /some/page.mdx`).

Parametersqueryrequiredversion

query_docs_filesystem_spree_commerce_documentation

Query documentation filesystem

Run a read-only shell-like query against a virtualized, in-memory filesystem rooted at `/` that contains ONLY the Spree Commerce documentation documentation pages and OpenAPI specs. This is NOT a shell on any real machine — nothing runs on the user's computer, the server host, or any network. The filesystem is a sandbox backed by documentation chunks. This is how you read documentation pages: there is no separate "get page" tool. To read a page, pass its `.mdx` path to `head` or `cat` — a page at the URL path `/some/page` lives at `/some/page.mdx`. To search the docs with exact keyword or regex matches, use `rg`. To understand the docs structure, use `tree` or `ls`. **Paths are specific to this site — never guess them.** Discover real paths with `tree / -L 2`, `ls /`, or the search tool before reading. If a path does not exist, that only means the guess was wrong; it does NOT mean the topic is undocumented — use `rg -il "keyword" /` to find where it is covered. **Workflow:** Start with the search tool for broad or conceptual queries like "how to authenticate" or "rate limiting". Use this tool when you need exact keyword/regex matching, structural exploration, or to read the full content of a specific page by path. Supported commands: rg (ripgrep), grep, find, tree, ls, cat, head, tail, stat, wc, sort, uniq, cut, sed, awk, jq, plus basic text utilities. No writes, no network, no process control. Run `--help` on any command for usage. Each call is STATELESS: the working directory always resets to `/` and no shell variables, aliases, or history carry over between calls. If you need to operate in a subdirectory, chain commands in one call with `&&` or pass absolute paths (e.g., `cd /some-directory && ls` or `ls /some-directory`). Do NOT assume that `cd` in one call affects the next call. Examples (replace the placeholder paths with real ones from `tree` or search): - `tree / -L 2` — see the top-level directory layout - `rg -il "rate limit" /` — find all files ment

Parameterscommandrequired

submit_feedback

Submit documentation feedback

Report a problem with this documentation site so the docs team can fix it. Use when a documentation page is incorrect, outdated, confusing, incomplete, or has a broken example. This is for feedback about the documentation content itself — not for product support requests or feedback about this tool or assistant.

Parameterspathrequiredfeedbackrequired

Version history

1
  1. v1.0.0LatestOct 30, 2026

Score

100% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts