Spree Commerce developer docs for AI agents

io.github.spree由 GitHub 账号 spree 发布v1.0.0更新于 Nov 7, 2026

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

已验证Streamable HTTP可网页运行知识与记忆开发者工具

概览

AI 生成的概览

远程 MCP 服务器,让助手检索 Spree Commerce 文档并查询其文档文件系统,以回答电商开发问题。

可以做什么
  • 在 Spree Commerce 文档知识库中搜索指南、API 参考和代码示例
  • 对仅含文档页面与 OpenAPI 规范的虚拟内存文件系统执行只读的类 shell 查询
  • 向文档团队报告文档问题,例如错误、过时或不完整的页面
适用场景
适合在基于 Spree Commerce API 构建无头 B2B 或市场型电商时,让回答以官方文档为依据而非模型记忆。也便于定位具体指南、API 参考或 OpenAPI 规范。
运行要求
需要访问 spreecommerce.org 上的远程 streamable HTTP 端点;未声明任何软件包、账号、API 密钥或环境变量。需要网络访问该站点。
安装前请注意
submit_feedback 工具会把内容发送给文档团队,反馈中不要包含密钥或私密信息。除此之外,该服务器被描述为只读且仅限已发布文档,不提供对私有或需认证内容的访问。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Spree Commerce developer docs for AI agents,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

交给智能体安装

把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。

阅读 https://sourceweft.com/mcp/io.github.spree%2Fecommerce-docs/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。

查看智能体所依据的安装指南

其他 MCP 客户端

把它添加到你客户端的 mcpServers 配置中。

{
  "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.

来源:docs/README.md,提交 4cfb2ab

工具

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`).

输入参数query必填version

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

输入参数command必填

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.

输入参数path必填feedback必填

版本历史

1
  1. v1.0.0最新Oct 30, 2026

评分

已满足适用检查项的 100%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分
  • 已声明认证方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分