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 分