Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Changed the MCP docs to describe what the server does

Damian Legawiecd5699408bfff
diff --git a/docs/developer/mcp/overview.mdx b/docs/developer/mcp/overview.mdx
index 0442cd681d..dfe9f40eed 100644
--- a/docs/developer/mcp/overview.mdx
+++ b/docs/developer/mcp/overview.mdx
@@ -17,7 +17,7 @@ https://your-store.com/api/v3/admin/mcp
The back office: the catalog, orders, reporting and store setup, for staff and the agents they connect.
<Note>
- A storefront endpoint, for agents acting on a customer's behalf, is not built yet. The machinery is shared and the catalogs are separate, so it arrives as an addition rather than a rework — see [what is not here yet](#what-is-not-here-yet).
+ One endpoint, one audience. The tools an agent is offered here are the back office's, and a merchant's grant is measured against their own staff permissions — so an agent reaches exactly what the person who connected it can reach.
</Note>
## How it fits together
@@ -52,9 +52,3 @@ Every tool reaches data by making a real API request inside the process — the
**Not the documentation server.** The [docs MCP server](/developer/agentic/mcp) lets an agent read Spree's documentation while writing code against it. This one operates a live store. They are unrelated and you can use both.
**Not a replacement for the API.** An agent is good at a merchant's request in words. A scheduled job, a data pipeline or a storefront should call the [Admin API](/api-reference/admin) or the [`spree api` CLI](/developer/cli/admin-api) directly.
-
-## What is not here yet
-
-- **A storefront endpoint.** Tools for a customer-facing agent — browsing, carts, order status — need a customer principal and their own catalog.
-- **Order editing.** Adding line items, discounts and fees to an existing order runs through paths that are not yet workflows, so no tool offers it. Cancelling, refunding and fulfilling all work today.
-- **Product status moves.** Activating, drafting and archiving a product run inside the Spree process rather than through an endpoint, because the Admin API has none for them yet.
diff --git a/docs/developer/mcp/quick-start.mdx b/docs/developer/mcp/quick-start.mdx
index bbd72edcc9..563b71c7f4 100644
--- a/docs/developer/mcp/quick-start.mdx
+++ b/docs/developer/mcp/quick-start.mdx
@@ -94,7 +94,7 @@ What you approve matters more than it looks:
- **An agent never gets more than you have.** The grant narrows your own permissions, so a staff member who cannot issue refunds cannot approve an agent that can.
- **Only what you approved.** Approving product access does not quietly include orders — the tools for anything else are not even offered to the model.
-- **It is yours, not the store's.** Each person connects for themselves, so an agent's actions are recorded against whoever approved it.
+- **It is yours, not the store's.** Each person connects for themselves, so an agent's actions are recorded against whoever approved it, and revoking one person's access leaves their colleagues working.
[Permissions and consent](/developer/mcp/permissions) covers this in full.
@@ -134,7 +134,7 @@ Ask the agent directly — `describe_resource` with no arguments lists every res
</Accordion>
<Accordion title="Nothing is listed under AI Agents">
- Connections are per person. You are looking at your own; another staff member's connection appears under theirs.
+ The page lists each agent registered for the store with the people connected through it. An agent nobody has connected yet shows no one — register it under **Settings → OAuth clients**, then connect from your own client.
</Accordion>
</AccordionGroup>
diff --git a/docs/developer/mcp/tools.mdx b/docs/developer/mcp/tools.mdx
index 0fdada6101..7513237828 100644
--- a/docs/developer/mcp/tools.mdx
+++ b/docs/developer/mcp/tools.mdx
@@ -133,7 +133,7 @@ Beyond tools, the server offers MCP **resources** — files a client can fetch r
| Resource | What it is |
| --- | --- |
-| `spree+export://<id>` | A finished export, as CSV. Reading one costs the same permission as reading the records in it. |
+| `spree+export://<id>` | A finished export, as CSV. Reading one costs the same permission as reading the records in it, and an export of gift cards or coupon codes is never readable here. |
A product's media, an order's purchase order and an import's own file are things an agent *puts* there rather than reads back, so they are uploads rather than resources.
@@ -144,7 +144,7 @@ Some things are out of reach whatever a grant holds.
- **Credentials.** API keys, integrations, webhook endpoints and gift card codes are never returned by any tool. A gift card code is the money itself, and an integration's settings are where provider credentials live.
- **Minting another credential.** A grant cannot create API keys, roles, staff accounts or another OAuth client — so an agent can never widen its own reach.
- **Erasing a customer.** GDPR erasure is irreversible and is not something to put behind a single confirmation prompt. Do it in the dashboard.
-- **Order editing.** Adding line items, discounts and fees to an existing order runs through paths that are not yet workflows. Cancelling, refunding and fulfilling all work today.
+- **Codes that spend money.** A gift card or coupon export carries live codes, so no tool creates or reads one. Download it from the dashboard.
25 further workflows are excluded for reasons a contract spec enforces, so one cannot be exposed by accident.