list_sites
List connected stores
List all registered e-commerce sites. Use this first to find a site by name (e.g. "Pronto Partners") and get its site_id, which is required by all other tools.
无需输入参数。
io.github.themewireco由 GitHub 账号 themewireco 发布v0.5.21更新于 Oct 24, 2026
Shop connected e-commerce stores: search, compare, cart, and checkout with buyer approval.
将助手连接到 Synchronity 托管网关,可在多家已接入的电商店铺中搜索、比价、加购并完成结账。
Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。
把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。
阅读 https://sourceweft.com/mcp/io.github.themewireco%2Fsynchronity/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。把它添加到你客户端的 mcpServers 配置中。
{
"mcpServers": {
"synchronity": {
"type": "http",
"url": "https://api.synchronity.app/mcp"
}
}
}Shop anything online with AI — search, compare, and buy across connected stores from any AI assistant.
Synchronity is commerce infrastructure for AI assistants. It connects to the hosted Synchronity gateway at https://api.synchronity.app — there is nothing to self-host.
This repository contains the public, MIT-licensed pieces:
Releases attach prebuilt artifacts: the
synchronity.mcpbdesktop extension and the WooCommerce plugin zip. See Releases.
synchronity.mcpb from the latest release (or from api.synchronity.app/setup/download).Then just shop — "find me a birthday cake from my stores". The plugin bundles
the synchronity-commerce skill and runs the MCP server locally via npx, so
there is nothing to clone or build.
Add the Synchronity plugin from this repo (plugins/synchronity). Codex
reads .codex-plugin/plugin.json and connects to the hosted MCP at
https://api.synchronity.app/mcp, with the same synchronity-commerce skill.
GATEWAY_URL defaults to https://api.synchronity.app. Sensitive actions (checkout, payment) require buyer approval — the assistant walks you through a one-time approval step.
Product search & details (with inline images), compare across stores, reviews, cart management, shipping, checkout, card/mobile-money payment, order tracking, and human-in-the-loop approval for sensitive actions.
Your store keeps its own catalog, currency, shipping, and orders — Synchronity routes agent requests to it through the gateway.
New here or reviewing the connector? Follow the end-to-end walkthrough: docs/reviewer-testing.md.
MIT © Themewire — see LICENSE.
来源:README.md,提交 4af5f71
List connected stores
List all registered e-commerce sites. Use this first to find a site by name (e.g. "Pronto Partners") and get its site_id, which is required by all other tools.
无需输入参数。
Search products
Find products on a registered store. To BROWSE a store's catalog (open-ended requests like "what do they sell", "show me what's available"), call with NO query — this returns the store's products. To SEARCH, pass `query` (a product name/keyword). Returns paginated products as an interactive card. ALWAYS translate a buyer's budget or price constraint into the price params on THIS call instead of filtering in your reply: "under/below/within X" or "X budget" → `max_price: X`; "over/above/at least X" → `min_price: X`; "between X and Y" → both. Likewise pass `in_stock: true` for "available"/"in stock" and `category` when they name one. The card renders exactly what this call returns, so the filter MUST be applied here — never fetch the full catalog and then narrow it in text. Call once with your best intent (browse OR a single query); if a real search is genuinely empty, ask the user to clarify rather than re-firing reworded queries. The card shows products, prices, IDs, and Add-to-cart controls — keep your text reply to one brief sentence and do not re-list what the card shows.
pagequeryqueriessite_id必填categoryin_stockper_pagemax_pricemin_priceGet product details
Retrieve detailed information about a specific product including variants, pricing, images, and availability. May also return `addons` — customer-selectable options defined by the store (e.g. engraving, gift wrap, size add-ons). When a product has addons, present them to the buyer and collect every addon with `required: true` before calling add_to_cart; for any option carrying a `price_modifier`, show that surcharge so the buyer knows the added cost. The card already shows the product details to the user, so keep your text reply brief and do not re-describe what the card displays.
site_id必填product_id必填Get product reviews
🔍 **RECOMMENDED STEP** — Fetch product reviews and authenticity consensus before making purchase decisions. Returns: average rating, trust score (0.0-1.0), review sentiment analysis, authenticity flags (fake reviews, seller issues, negative trends), and recent reviews with verified purchase status. Always call this for each product before adding to cart to verify quality and detect scams.
pagelimitsite_id必填product_id必填Notify me when back in stock
Subscribe the buyer to a back-in-stock alert for an out-of-stock product. Use when the buyer asks to be notified/told/pinged when an item restocks ("notify me when X is back", "let me know when it's in stock"). Collect the buyer's email so the alert can reach them (without it only the demand is recorded for the merchant). The buyer is emailed when the product is next seen in stock. Returns whether an email alert was armed.
emailsite_id必填product_id必填variant_idproduct_titleCompare products across stores
Compare products across multiple registered e-commerce sites simultaneously. Uses fail-open strategy: partial results from successful sites are returned even if some sites time out.
query必填categoryin_stocksite_ids必填max_pricemin_priceCreate cart
Create a new shopping cart for a specific site. Returns a cart_id. IMPORTANT: Reuse the active cart_id across multiple products in the same session. Do NOT call create_cart again if you already have a cart_id for this site in the chat history.
site_id必填currencyAdd item to cart
Add a product variant (or base product) to an existing cart. Reuse the active cart_id from the chat history if one already exists. Only call create_cart first if no cart exists yet.
emailitemsaddonscart_idsite_id必填quantityproduct_idvariant_idQuick checkout (build carts)
Assemble checkout-ready cart(s) in ONE call for a multi-product (and optionally multi-store) request. Creates a cart per store, adds all items, and sets the shipping address — then returns the cart(s) with delivery options to choose. Use this when the buyer lists several products at once (optionally across stores) and/or gives their address up front, instead of calling create_cart/add_to_cart/set_shipping_address separately. Does NOT select delivery, check out, or pay — the buyer picks delivery (select_shipping_option) and approves checkout/payment per store afterward. Out-of-stock items are reported; pass customer.email to auto-arm a back-in-stock alert for them.
items必填customershipping_address必填Remove item from cart
Remove a line item from the cart. Requires the item_id from the cart contents.
cart_id必填item_id必填site_id必填Set item quantity
Set a cart line's quantity (the server cart is the checkout source of truth, so this updates it live). Requires the item_id from the cart contents and the new absolute quantity. A quantity of 0 removes the line. Returns the updated cart card.
cart_id必填item_id必填site_id必填quantity必填Apply coupon
Apply a discount or promotional code to the cart. Returns the updated cart with discount applied.
code必填cart_id必填site_id必填View cart
Retrieve current cart contents, including items, pricing, discounts, and totals. The card already shows the line items and totals to the user, so keep your text reply to one brief sentence — do not re-list the cart contents.
cart_idsite_id必填Resume active cart
Retrieve the buyer's in-progress cart for a site (resumes a conversation). Call this before assuming a new cart when a shopping conversation continues or after a cart error. Returns the cart with its items rebuilt if the connector cart expired, or null if no cart exists.
site_id必填Set shipping address
Set the cart shipping destination (collected from the buyer) and return available shipping options with costs. Call after items are in the cart and before select_shipping_option. country_code is required; include postal_code/state for accurate rates.
citystatecart_id必填site_id必填postal_codecountry_code必填Select shipping option
Select one of the shipping options returned by set_shipping_address. Binds the rate to the cart so the total includes shipping; call before execute_checkout so the hosted checkout opens pre-filled.
cart_id必填site_id必填option_id必填Place order (checkout)
Execute checkout for a cart to create an order. Requires a buyer delegation token (from user auth) and a shipping address. The order is created UNPAID (status "pending"). IMPORTANT — do NOT stop here or just hand the user the payment_url. Immediately continue the in-chat payment flow: call get_payment_methods for the returned order_id, present the available channels to the buyer, and ask which they want to use; then drive initiate_payment → (submit_payment_otp if needed) → poll get_payment_status until the order is paid. The payment_url in the response is only a manual fallback if the buyer declines in-chat payment. Always offer to collect payment in the chat first.
notescart_id必填site_id必填customer_name必填shipping_city必填shipping_name必填customer_email必填customer_phone必填shipping_line1必填shipping_line2shipping_phoneshipping_state必填另有 3 个Get order details
Retrieve details for an order by its ID, including items, status, shipping, and tracking information. Orders are buyer-private — pass `buyer_delegation_token` (the delegation token from this buyer's checkout approval) so the gateway can confirm the buyer owns this order. If checking if an order is paid: a status of 'pending' or 'pending_payment' means the order has NOT been paid. Do NOT assume that the vendor storefront has synchronization delays or database lag; treat 'pending' as unpaid. When an order is unpaid, offer to collect payment in the chat by starting the in-chat payment flow (get_payment_methods → initiate_payment → get_payment_status) rather than only pointing the user at the payment_url. Do not mark the purchase task as successful until the status updates to 'processing' or 'completed'.
site_id必填order_id必填buyer_delegation_tokenList orders
List recent orders for a site, optionally filtered by status (pending, processing, completed, cancelled, refunded). Orders are buyer-private — pass `buyer_delegation_token` (from this buyer's checkout approval); only that buyer's orders are returned.
pagestatussite_id必填per_pagebuyer_delegation_tokenRequest buyer approval
Start the human delegation (approval) flow needed for checkout/payment. PREFERRED: pass the buyer's `email` — the gateway emails them a 6-digit code and returns a device_code; ask the user for the code and call submit_delegation_otp. This keeps approval fully in-chat (no link) and you never see the code, so you cannot approve on their behalf. If you omit `email`, it falls back to a browser approval link (device flow) which the user must open; then poll check_delegation. You can never approve a delegation yourself.
emailscopessite_id必填marketing_opt_inSubmit approval code
Submit the 6-digit code the buyer received by email (from request_delegation with an email) to approve the delegation in-chat. On success returns a delegation_token to use as buyer_delegation_token for checkout/payment. You cannot obtain this code yourself — the user must read it from their email and give it to you.
code必填site_iddevice_code必填Check approval status
Poll for human approval of a delegation request. When status is "approved", returns the delegation_token to use as buyer_delegation_token in execute_checkout.
device_code必填Get payment methods
STEP 1 of the in-chat payment flow. Returns the payment channels available for an order (e.g. "mobile_money", "card") plus a `gateways` array of the enabled payment gateways (each with id, label, and its channels). When more than one gateway is listed, ask the buyer which they want to use and pass it as `gateway` to initiate_payment. Call this first, after an order exists. Then call initiate_payment with the chosen channel (and gateway if more than one). site_id falls back to DEFAULT_SITE_ID if omitted.
site_idorder_id必填Start payment
STEP 2 of the in-chat payment flow. Starts a payment session for an order and returns a PaymentSession with an `instruction` the agent renders in chat. REQUIRES a buyer_delegation_token — obtain it exactly like execute_checkout: call request_delegation, have the user approve in chat, then check_delegation to get the token (spending money always needs human approval). For channel "mobile_money" you MUST collect the buyer's `phone` (Ghana: 055… or +233…) and `provider` — use codes mtn, vod (Vodafone/Telecel), or tgo (AirtelTigo); aliases telecel→vod, tigo→tgo are accepted. ALWAYS quote the **Show this instruction to the buyer** line from the response verbatim (Paystack display_text). For channel "card", no phone/provider is needed; the response instruction contains an `authorization_url` you send the user to. After calling: if instruction.action == "submit_otp", ask the user for the OTP and call submit_payment_otp. If instruction.action == "approve_on_phone", tell the user to approve the prompt on their phone, then poll get_payment_status. If instruction.action == "redirect" (card), send the user the authorization_url, then poll get_payment_status.
phonechannel必填gatewaysite_idorder_id必填providerbuyer_delegation_tokenSubmit payment code
STEP 3 (mobile_money only, when initiate_payment returned instruction.action == "submit_otp"). Submits the one-time password the buyer received to authorise the mobile-money charge. REQUIRES the same buyer_delegation_token used for initiate_payment. After submitting, poll get_payment_status until payment_status is "paid"/"processing" or "failed".
otp必填site_idorder_id必填buyer_delegation_tokenCheck payment status
FINAL STEP of the in-chat payment flow. Returns the current PaymentSession for an order. Poll this (every ~5 seconds) after initiate_payment/submit_payment_otp until payment_status becomes "paid" or "processing" (success — the order is confirmed) or "failed" (tell the user; they can retry by initiating a new payment). Do NOT treat the purchase as complete until this returns "paid" or "processing". No delegation needed (read-only).
site_idorder_id必填已满足适用检查项的 100%
该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。
/plugin marketplace add themewireco/synchronity/plugin install synchronity@synchronitynpm install && npm run build{ "mcpServers": { "synchronity": { "command": "node", "args": ["/absolute/path/to/synchronity/packages/mcp/dist/index.js"], "env": { "GATEWAY_URL": "https://api.synchronity.app" } } }}npm run build # build the MCP server + clientnpm run build:mcpb # -> synchronity.mcpb (Claude Desktop extension)npm run build:plugin # -> synchronity-woocommerce-v<version>.zip