@cmssy/mcp-server
OfficialAn MCP server for the Cmssy headless CMS that lets an AI agent read and write a workspace's pages, blocks, media, forms, data models, commerce, customers, price lists, sales channels and webhooks.
Pages & blocks — list/get/create/update/publish/unpublish/delete pages, manage page types and custom fields, edit blocks (add, update, patch HTML surgically, remove), layout and region settings, per-user dev drafts, and page locks.
Site & workspace — site config, workspace info/limits, block types and block usage auditing, members and roles.
Media — list/upload assets (local path or URL, 50MB), organize with folders, move assets.
Forms — create/update/delete forms, list and triage submissions.
Data models & records — define models with typed fields, relations and status lifecycles, then CRUD, filter, bulk import (up to 1000) and bulk update records.
Commerce — orders (manual creation, payments, refunds, cancel/close, pipeline stages, invoices, shipments, returns), carts, discounts, product catalog with stock/variants/tiers, and cart configuration.
Customers — list/get, suspend/unsuspend, unlock, password reset and verification resends, company roles and price lists.
Price lists & sales channels — tiered pricing with percent-off and fixed prices, channel-based pricing, company VAT/tax settings.
Webhooks — manage endpoints, rotate secrets, inspect deliveries and event types.
Email — list email configurations for form notifications.
Provides setup files and guidance for building a Next.js site backed by Cmssy, including a catch-all page, editor route, proxy, config, block registry, environment variables, and header/footer layout regions.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@@cmssy/mcp-server create a new 'Contact' page with a form and publish it"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
@cmssy/mcp-server
MCP server for Cmssy, a hosted headless CMS with built-in commerce. Lets an AI agent work with pages, records, media, forms, products, orders, refunds and discounts in a Cmssy workspace.
Hosted server (no install)
https://api.cmssy.io/mcp serves the same tools over HTTP. Claude (web, desktop, Code) and Codex connect by signing in to cmssy. A client that asks for a server URL and an API key - v0, Lovable, Bolt or your own - sends a cs_ token instead:
URL: https://api.cmssy.io/mcp
Header: Authorization: Bearer cs_YOUR_TOKENA token scoped to one workspace reaches only that workspace; an unscoped token reaches every workspace you belong to. Every tool takes a workspace (<orgSlug>/<workspaceSlug>), and list_workspaces names the ones the token may use. It reads and writes with your role in each workspace. Changing your password does not revoke it - delete it under Dashboard > API Tokens. Details: cmssy.com/docs/api/mcp.
Related MCP server: Strapi Content MCP
Setup
Prerequisites
A Cmssy workspace - the free plan works; cart and checkout need Pro
An API token (Dashboard > API Tokens, starts with
cs_)Your workspace ID (Workspace Settings > General)
The server talks to https://api.cmssy.io by default. Pass --api-url only for another backend.
Add to Claude Code
Add to .mcp.json in your project root:
{
"mcpServers": {
"cmssy": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@cmssy/mcp-server@latest",
"--token",
"cs_YOUR_TOKEN",
"--workspace-id",
"YOUR_WORKSPACE_ID"
]
}
}
}Environment Variables
Instead of CLI args, you can set:
CMSSY_API_TOKEN— API token (cs_xxx)CMSSY_WORKSPACE_ID— Workspace IDCMSSY_API_URL— API URL (optional; defaults tohttps://api.cmssy.io, so set it only for a self-hosted backend)
Checking which build is running
--version and --help need no token, so they answer even when the server is
not configured. Run the flag against the same spec your client launches,
copied out of your mcp.json:
npx -y @cmssy/mcp-server --version # what an unpinned config runs
npx -y @cmssy/mcp-server@latest --version # what the registry serves today
npm view @cmssy/mcp-server version # the newest published versionThe first two can disagree, and that disagreement is the answer: a warm npx
cache holds the build an unpinned spec resolved to earlier, while @latest
re-resolves and reports the newest one. So @latest --version cannot diagnose
a stale cache - it is the command that hides it. Ask the unpinned spec first
when a tool fails on a field the API should serve, then compare.
Clearing the cache is npx clear-npx-cache, or pin the version in your config
so nothing has to be diagnosed.
Privacy Policy
Full policy: https://www.cmssy.com/privacy. Contact: contact@cmssy.com.
What this server collects: nothing of its own. It keeps no local database, writes no files and sends nothing to any analytics service.
What it sends, and where: each tool call becomes a GraphQL request to the Cmssy API (
https://api.cmssy.iounless you setCMSSY_API_URL), carrying your API token, your workspace ID, the tool's arguments, the client name and version, and the name of the tool being run. The Cmssy API records one usage event per tool call from those last two.Files and URLs:
upload_mediareads only the local file path or downloads only the URL you pass it, then uploads the bytes to the Cmssy storage URL the API returns. It touches no other file.Usage and storage: the Cmssy API stores workspace content (pages, records, media, orders, customers) as described in the policy above, in the European Union. Content is not sold and not used to train AI models.
Third-party sharing: the server talks to the Cmssy API and the Cmssy storage URL only, plus any URL you hand to
upload_media. Third parties the Cmssy service itself uses are listed in the policy.Data retention: the server keeps nothing after a call returns. Workspace data stays until you delete it or close your account; retention periods are in the policy.
Your token: it acts with the permissions of the member who created it. Revoke it under Dashboard > API Tokens at any time.
Response shape (write tools)
As of 0.6.0, most write tools accept an optional response arg:
response: "minimal"(default) - returns a small ack (~200 bytes):{id, slug, hasUnpublishedChanges, updatedAt}for page tools,{pageId, blockId, hasUnpublishedChanges, updatedAt}for block tools,{id, slug, status, updatedAt}for form tools,{id, slug, updatedAt}for model tools,{id, status, updatedAt}for record tools,{id, orderNumber, status, paymentStatus, fulfillmentStatus, total, balanceDue, currency, updatedAt}for order tools,{id, code, type, value, enabled, updatedAt}for discount tools.response: "full"- returns the full mutation response (pre-0.6 behavior).
Use "full" only if you need the post-write state inline; otherwise issue a
follow-up get_page/get_form/get_model/get_record. This keeps agent
context windows from being eaten by echoed content.
Tools that accept response: create_page, update_page_blocks,
update_page_settings, publish_page, unpublish_page, revert_to_published,
update_page_layout, add_block_to_page, update_block_content,
remove_block_from_page, create_form, update_form, create_model,
update_model, create_record, update_record, create_manual_order,
edit_order, update_order_details, mark_order_paid, record_order_payment,
refund_order, cancel_order, close_order, reopen_order,
create_return, approve_return, reject_return, cancel_return,
receive_return, refund_return, complete_return, update_return_tracking,
create_shipment, update_shipment,
set_order_pipeline_stage, record_order_invoice,
record_order_invoice_correction, create_discount,
update_discount, set_discount_enabled.
patch_block_content and the various delete_* / status-only tools
(update_form_submission_status, import_records)
already returned a compact ack and don't take response.
Building a site
On connect the server sends instructions that send an agent (v0, Lovable, Bolt, Claude) to get_site_setup first. It returns the files cmssy init writes for Next.js - catch-all page, editor route, proxy, config, block registry, header/footer regions - with the workspace's env vars filled in. The agent then deploys, calls set_preview_url, creates the content.changed webhook for /api/revalidate, has the user open the editor once so the block types register, creates the pages with header and footer in their layout regions, and publishes them.
Available Tools
Read Tools
Tool | Description |
| Everything to build a site on the workspace: the files to write, packages, env vars filled in, steps |
| Page tree with hierarchy (optional |
| Full page with blocks, i18n content and region settings (own |
| Languages, navigation, site name |
| Workspace name, plan, limits |
| Media library listing |
| Page trash: deleted groups with who deleted them, subtree size and when each is purged (30 days after deletion) |
Write Tools
Tool | Description |
| Create a new page |
| Set full blocks array on a page |
| Update page metadata and SEO |
| Publish a page |
| Point the editor at the deployed app (stores the URL's origin) |
| Unpublish a page |
| Move a page and its subtree to the trash, restorable for 30 days |
| Restore a trashed page group as unpublished drafts |
| Discard draft, revert to published |
Block Helper Tools
Tool | Description |
| Insert a block at position (auto-generates UUID + translations) |
| Merge content into an existing block |
| Surgical HTML patch (insert/replace around unique markers) |
| Remove a block by ID |
| Update layout blocks and overrides |
| Set one layout region's settings (manifest-validated; other regions untouched) |
update_region_settings
Region (layout position) settings are declared by the workspace's layout
manifest and validated against it on write. The tool reads the page's current
layoutRegionSettings, replaces only the named region and writes the whole
list back, so sibling regions keep their values (entries for regions the
manifest no longer declares, and keys a region's schema no longer has, are
dropped on the way - the same pruning the admin editor does). The backend's own
BAD_USER_INPUT message is returned verbatim for an unknown region, an unknown
key, or a non-empty values on a region that declares no settings (such a
region accepts values: {} only); blockWarnings are surfaced when present.
{ "pageId": "...", "region": "sidebar", "values": { "width": "wide" } }Child pages inherit a region's settings unless they set their own -
get_page shows the effective value per region in resolvedRegions
(settingsAreInherited, settingsSourcePageId).
patch_block_content
For small edits on long HTML content strings (e.g. a docs-article body),
patch_block_content is ~10x cheaper in tokens than update_block_content
and catches marker mistakes before anything writes to the DB.
{
"pageId": "...",
"blockId": "...",
"locale": "en",
"operations": [
{
"op": "insert_before",
"marker": "<h2>Environment Variables</h2>",
"html": "<hr><h2>cmssy skills install</h2><p>...</p>",
},
],
}Four ops: insert_before, insert_after, replace_section, replace_all.
Every marker must match exactly once - 0 or 2+ matches error out with the
actual count (no silent half-applied state). For replace_section,
startMarker is inclusive and endMarker is exclusive. replace_all sets the
whole string and takes expected, the current value - refused if it moved.
Requires @cmssy/cli-registered workspace with PAGES_EDIT permission.
Default fieldPath is "content" (the HTML body on docs-article); override
if patching a different string field. Dot segments reach a nested string, e.g.
tabs.0.label for the first tab's label.
Model Tools (Custom Data Models)
AI agents can define ModelDefinitions and CRUD their records. Schema/fields
follow PropertyField from @cmssy/types; records are validated against the
model on every write.
Tool | Description |
| List all ModelDefinitions in the workspace |
| Get a model by id (ObjectId) or slug |
| Create a model (name, slug, fields, optional statusField) |
| Update any field of a model (fields change triggers schema migrate) |
| Delete a model — cascades to all its records |
| List records with filter (JSON), sort, cursor pagination, optional populate |
| Get a record by id; a company record carries its VAT id, verification and exemption |
| Create a record; |
| Update a record's data and/or transition its status |
| Delete a record |
| Bulk import up to 1000 records; returns |
| Set data and/or status on up to 200 ids or every filter match |
Requires workspace permissions MODELS_VIEW (read) / MODELS_CREATE /
MODELS_EDIT / MODELS_DELETE depending on the operation.
Commerce Tools (Orders, Carts, Discounts)
Manage the storefront's orders, carts, and discount codes. All money fields
are integer minor units (cents). Order/discount write tools accept the
response arg (see Response shape).
Tool | Description |
| List orders by payment/fulfillment/delivery/state, warehouse queue, customer, currency, dates; pages with |
| Get an order with items, payments, parcels, invoices and corrections, tax summary and treatment, sales channel and the price lists that priced it |
| Get the workspace's configurable order pipeline stages |
| Create an admin-entered order, with an optional shipping address |
| Replace an order's line items (recomputes totals) |
| Update customer email, notes, PO number, and shipping address |
| Record a full payment (manual reconciliation, no provider verify) |
| Record a partial payment against the balance due |
| Refund an order (full, or partial with |
| Cancel an order |
| Mark an order done; reopens itself if payment or fulfillment slips |
| Reopen a closed order |
| Open a return: lines, quantities, reasons, return-parcel tracking |
| Approve a return the customer requested |
| Reject a requested return |
| Cancel a return not yet refunded |
| Record received units per line and how many go back to stock |
| Record a refund for a return |
| Close a received return without a refund |
| Set the carrier and tracking number of the return parcel |
| Add a parcel (carrier, tracking number, link, status) to an order |
| Change a parcel's status or tracking, with a note for its history |
| Move an order to a pipeline stage |
| Attach an invoice (number, url, provider) to an order |
| Attach a correction invoice (credit note) to an invoiced order |
| List shopping carts (admin view, optional status filter) with their sales channel |
| Permanently delete 1-100 carts, all or nothing |
| List discount codes (filter by enabled/type/code) |
| Get a discount by id |
| Create a discount ( |
| Partial update (code/type/currency lock once the code is used) |
| Enable or disable a discount |
| Product catalog with stock + variant info (over a Data Model) |
| Bulk set/adjust status, stock, or price on selected products |
| Bulk-delete selected product records |
| Background job: delete every product matching a filter (over 1000 matches) |
| Background job: patch every product matching a filter (over 1000 matches) |
| Status and progress of a product bulk job, by id or the model's active job |
| Set a product's record-level volume price breaks |
| Replace a product's whole variant set |
| Replace a product's prices and breaks in additional currencies, and variants' per-currency prices without touching stock |
Products are records of a Custom Data Model; these tools add product-aware
stock/variant reads and bulk writes on top of the generic record tools. The
bulk tools target an explicit ids list or everything matching a filter
(allMatching: true). There is no per-variant stock write and no standalone
inventory mutation - stock is set/adjusted in bulk via patch.setStock /
patch.adjustStock.
Requires workspace permissions ORDERS_VIEW / ORDERS_MANAGE (orders),
CARTS_VIEW (carts), DISCOUNTS_VIEW / DISCOUNTS_MANAGE (discounts),
MODELS_VIEW / MODELS_EDIT / MODELS_DELETE (products).
Customer Tools
Customers are the accounts that sign in to the site - records of a model
with accounts enabled - not the team that manages the workspace
(list_team).
Tool | Description |
| List customers with status, verification, last login, company and order stats (cursor-paginated) |
| One customer's account summary plus the profile record's data |
| Block sign-in and end every live session (orders and carts stay) |
| Let a suspended customer sign in again |
| Issue a reset token to an active customer; the app's |
| Issue a fresh verification token to a pending customer; the app's webhook sends the mail |
| Clear the failed sign-in counter and lockout |
| Give a customer a role in their company ( |
| Assign a price list to a customer without a company; |
Price List Tools
A price list (Gold, Silver, dealer tiers) prices a buyer at a percent off the catalogue plus fixed prices per product or variant. Each buyer has one list: a company's members pay the company's list, a customer without a company their own.
Tool | Description |
| Every price list with percentOff, fixed-price count, assignment count and channels |
| One list with a page of its fixed prices (filter by product, cursor-paginated) |
| Create a list with a name, an optional percent off and the channels it is published to |
| Rename a list, change its percentOff, window or channels ( |
| Delete a list and unassign it everywhere |
| Set the fixed price for one product or variant, with optional volume breaks |
| Upsert up to 1000 fixed prices at once, all or nothing |
| Remove up to 1000 fixed prices by product / variant |
| Assign a price list to a company record; every member pays it; |
| Set whether a company's buyers read net or gross prices; |
| Set a company's VAT rounding, per_line or per_rate; |
| Set or clear a company's EU VAT id; a changed id is no longer verified |
| Attest or withdraw a company's checked VAT id; drives reverse charge |
| Exempt a company's orders from VAT with a legal reason; |
Sales Channel Tools
A sales channel (retail, horeca, b2b) is a key a storefront sends to be priced
from the price lists published to it: per product the buyer's own or company
list wins, then the channel's dated list, then its base list, then the
catalogue. Lists are published with create_price_list / update_price_list
channels.
Tool | Description |
| Every channel with key, displayMode, priceAccess, active list and open-cart count |
| One channel with its published lists, nextChangeAt and activeCartCount |
| Create a channel (key fixed once created), at most 20 per workspace |
| Rename a channel or change its displayMode or priceAccess |
| Delete a channel, unpublish its lists, abandon its open carts |
Webhook Tools
Manage outbound event webhooks. create_webhook and rotate_webhook_secret
return the signing secret once - it cannot be retrieved again.
Tool | Description |
| List webhook endpoints (secrets never returned) |
| Recent delivery attempts (pending/success/failed) |
| The authoritative allowlist of subscribable events |
| Create an endpoint; returns the endpoint + secret (once) |
| Partial update; pass |
| Rotate the signing secret (returns new secret once) |
| Delete an endpoint |
Requires workspace permissions WEBHOOKS_VIEW (read) / WEBHOOKS_MANAGE
(create, update, rotate, delete).
Email Tools
Tool | Description |
| Email configurations; the |
Requires workspace permission EMAIL_CONFIG_VIEW.
Resources
URI | Description |
| Full page tree as JSON |
| Workspace info + site config |
Example Workflow
> List all pages in my workspace
> Search for pages matching "blog"
> Show me the available block types
> Which pages still use block types the site no longer registers?
> Create a new "Features" page with content in English and Polish
> Add a hero block to the Features page
> Publish the Features pageHosting the server (library)
createHostedServer serves the same tools from a host that holds no token and no disk. Every tool takes a workspace (<orgSlug>/<workspaceSlug>); list_workspaces names the ones a connection may use. The package checks only the shape of workspace - everything below is the host's job:
resolveWorkspace(workspace)is the authorization. Check, on every call, that the caller is still a member of that workspace and that the connection was granted it. Throw the same message for "does not exist" and "not yours", so a refusal does not reveal which workspaces exist.The executor is the scope. The
CmssyApiit returns (createCmssyApi(execute, workspaceId)) runs every document as that user in that workspace; the package sends nothing that would scope it.fetchUrlis the SSRF boundary. Refuse private, loopback and link-local addresses and re-check every redirect. The package caps the body at 50MB while reading.
Development
pnpm install
pnpm dev -- --token cs_xxx --workspace-id xxx --api-url http://localhost:4000Available Tools
143 toolsadd_block_to_pageAdd block to pageADestructiveInspect
Add a block to a page (auto-generates the block id). Pass layoutRegion to add a layout block; omit it for a content block in the page body. If the result includes blockWarnings, the saved content violates the workspace block manifest (unknown field, wrong value shape, or a stored block whose type is no longer registered) - correct the content and save again, unless the warning is about a stored block whose type is no longer registered: that one is a manifest problem, so restore or sync the type, or find the block with list_block_usage and migrate or remove it. When the warnings also say when the workspace block manifest was last synced, the field or type may simply be newer than the manifest: if the site's code declares it, keep the content and sync the manifest (cmssy sync-manifest in the site's repo) instead. A block whose type the workspace block manifest does not register is refused unless the page already stores that block - pick registered types from list_block_types.
Inputs: block (required), pageId (required), position, layoutRegion.
approve_returnApprove returnCDestructiveInspect
Approve a return the customer requested.
Inputs: orderId (required), returnId (required), note.
bulk_delete_productsBulk delete productsADestructiveInspect
Bulk-delete selected product records permanently. A product still referenced by an open order or a page block is skipped rather than deleted; each entry of skipped carries its reason. With allMatching the call is refused when more than 1000 products match: use start_bulk_delete_products for that.
Inputs: modelId (required), selection (required).
bulk_update_productsBulk update productsADestructiveInspect
Bulk-update selected product records with a single patch (status, set/adjust stock, set/adjust price). Stock is whole units; price is major units - the stored price field value, not cents - and changes the default-currency price only; prices in additional currencies are left as they are. With allMatching the call is refused when more than 1000 products match: use start_bulk_update_products for that.
Inputs: patch (required), modelId (required), selection (required).
bulk_update_recordsBulk update recordsADestructiveInspect
Apply one change (field values, status and/or published) to many records of a model in a single call: the records named by ids, or every record matching filter with allMatching. Each record is validated, audited and announced to webhooks like update_record. Handles up to 200 records per call; a non-null nextCursor means more records match - pass it back with the same arguments to continue. Returns updated, unchanged (records already at the requested status and visibility, with no data to write), failedCount, a sample of failures (id + reason) and nextCursor.
Inputs: modelIdOrSlug (required), ids, data, cursor, +4 more.
cancel_orderCancel orderADestructiveInspect
Cancel an order. Takes only the order id - there is no reason field; when the user gives a reason, record it in the order's notes with update_order_details first.
Inputs: orderId (required).
cancel_returnCancel returnADestructiveInspect
Cancel a requested or approved return that has not been refunded.
Inputs: orderId (required), returnId (required), note.
clear_cart_configClear cart configADestructiveInspect
Remove the workspace's commerce settings entirely, putting the cart back to never-configured. A workspace with orders or carts is refused unless force: true is passed. To change individual settings rather than remove them, use update_cart_config.
Inputs: force.
close_orderClose orderADestructiveInspect
Mark an order done (state closed). Paid and fulfilled orders usually close by themselves; it reopens by itself if it later stops being paid or fulfilled.
Inputs: orderId (required).
complete_returnComplete returnADestructiveInspect
Close a received return without a refund, e.g. after store credit or a failed inspection.
Inputs: orderId (required), returnId (required), note.
create_discountCreate discountAInspect
Create a discount code. type is 'percentage' (value 0-100), 'fixed' (value in minor currency units, requires currency e.g. 'USD'; it applies only to carts in that currency), or 'free_shipping' (value 0). Optional limits: minSubtotal, maxUses, startsAt, endsAt. A cart is in its sales channel's currency; for a 'percentage' or 'free_shipping' code with a minimum, minSubtotal is the default-currency minimum and minSubtotalByCurrency the minimum in each additional currency.
Inputs: code (required), type (required), value (required), endsAt, +6 more.
create_formCreate formADestructiveInspect
Create a new form with a name and slug. Optional: field definitions, per-field showWhen/requiredWhen conditions, and settings (action type, notifications). Fields can also be added later in the Forms editor.
Inputs: name (required), slug (required), fields, settings, +1 more.
create_manual_orderCreate manual orderAInspect
Create a manual (admin-entered) order. Each item references a product recordId or is an ad-hoc line with name+price (minor units of the order's currency). currency picks the order's currency (default currency when omitted); payments and refunds on the order are in that currency. shippingAddress is optional; for a customer of a company with a verified VAT id its country decides whether the order is reverse charge, and the order freezes that tax treatment (get_order taxTreatment). Pass an idempotencyKey and, if the call times out or fails unclearly, retry with the same idempotencyKey so the retry cannot create a second order.
Inputs: items (required), customerEmail (required), currency, customerId, +2 more.
create_media_folderCreate media folderAInspect
Create a media folder for organizing assets. Returns the folder, whose id can be passed to upload_media (folderId) or move_media.
Inputs: name (required), parentId.
create_modelCreate modelAInspect
Create a data model in the workspace. Every field label (and description) is text per language code of the workspace: { en: "Title", pl: "Tytuł" }. Field types include select/multiselect (provide options as [{ value, label }] - the value is what records store), relation (link to another model via relationTo = the target model's slug + relationType), and object/list (nested fields/itemFields). Optional model-level config: slug, description, icon, color, displayField, defaultSort, statusField, product (commerce capability: enabled, priceField, skuField, inventoryField, variantAxes), auth (accounts: enabled, identityField, companyField for a B2B company link - a relation to a model with Company enabled, registration - "open" by default, "closed" when only admins create accounts, email - { enabled, links, templates } for cmssy sending account emails itself, off by default; a field's memberCanSet opens it to the member on their own account and at sign-up - registration accepts only those fields, never password fields or the company field), company ({ enabled }: its records are the companies an accounts model links; a model is at most one of product, account (auth) or company), uniqueFields (field keys whose value must be unique - lets import_records update by that key) and deliveryAccess - a model is "none" (admin only) by default, so pass "public" when the user's app must read it through the delivery API. urlPattern (e.g. /p/{slug}) says where its records live on the storefront, so their url becomes a working link - ask the user for their route rather than inventing one.
Inputs: name (required), fields (required), auth, icon, +11 more.
create_pageCreate pageAInspect
Create a new draft page with a name and slug (content/blocks are added later in the editor). Optional: parentId, pageType, multilingual displayName/seoTitle/seoDescription, customFields.
Inputs: name (required), slug (required), pageType, parentId, +5 more.
create_page_typeCreate page typeBInspect
Create a page type (template) with a custom-field schema. Pages of this type carry these custom fields.
Inputs: name (required), slug (required), icon, fields, +3 more.
create_price_listCreate price listAInspect
Create a price list: a percent off the catalogue (percentOff, -1000 to 99.99 with 2 decimals, default 0; negative = a markup) plus fixed prices per product or variant added with set_price_list_entry / set_price_list_entries. A fixed price overrides the percent for its product or variant; every other product gets the catalogue price minus percentOff. Then assign it to a company (set_company_price_list) or to a customer without a company (set_customer_price_list) - each buyer has one list: a company's members pay the company's list. startsAt / endsAt limit when it prices; outside that window its buyers pay catalogue prices. channels publishes it to sales channels by key: storefronts sending that channel are priced from it (a buyer's own or company list still wins for every product it prices), and anyone can read the prices of a list published to a PUBLIC channel.
Inputs: name (required), endsAt, channels, startsAt, +1 more.
create_recordCreate recordAInspect
Add a record (entry) to a data model. Pass the model id or slug and a data object whose keys are the model's field keys (use get_model first if unsure). A product is a record too: pass a model whose product capability is enabled (get_model shows product.enabled), and list_products then lists it with its stock. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.
Inputs: data (required), modelIdOrSlug (required), published.
create_returnCreate returnAInspect
Open a return on an order for items the customer is sending back. A return opened by the merchant starts approved. It does not move money or stock: receive_return restocks, refund_return records the refund. Pass an idempotencyKey and, if the call times out or fails unclearly, retry with the same idempotencyKey so the retry cannot open a second return on the order.
Inputs: lines (required), orderId (required), note, carrier, +2 more.
create_sales_channelCreate sales channelAInspect
Create a sales channel, at most 20 per workspace; a duplicate key is refused. The channel prices nothing until a price list is published to it (create_price_list / update_price_list with channels): one undated base list plus dated lists whose windows do not overlap. Channel keys are public - any storefront can send one - so priceAccess decides who sees its prices and may buy through it. currency picks what the channel sells in (the default currency when omitted): its carts, orders, shipping and discounts are in it, and a product with no price in it is not sold there.
Inputs: key (required), name (required), currency, displayMode, +1 more.
create_shipmentCreate shipmentAInspect
Add a parcel to an order: the items it carries, carrier, tracking and status. This is also how an order is marked fulfilled. The order's fulfillment and delivery status follow its parcels; a pending parcel (no label yet) fulfils nothing.
Inputs: orderId (required), note, items, status, +4 more.
create_webhookCreate webhookADestructiveInspect
Create a webhook endpoint subscribed to one or more events. The URL must be a public https endpoint. Returns the endpoint AND its signing secret (shown only once).
Inputs: url (required), events (required), description.
delete_cartsDelete cartsADestructiveInspect
Permanently delete 1 to 100 carts with their analytics events, the visitor sessions only they used and any discount use they held (the code's use count goes back down). All or nothing: an id that is not a cart of this workspace, or a cart already turned into an order (status ordered - anonymize the order instead), refuses the whole call and deletes nothing. Returns how many carts were deleted. Cannot be undone.
Inputs: ids (required).
delete_formDelete formADestructiveInspect
Permanently delete a form and all its submissions.
Inputs: idOrSlug (required).
delete_form_submissionDelete form submissionBDestructiveInspect
Permanently delete a form submission.
Inputs: submissionId (required).
delete_mediaDelete mediaADestructiveInspect
Move media assets to the trash. They can be restored in the cmssy admin for 30 days, after which they are deleted permanently. Assets still in use are refused unless force is set. Ids not found in this workspace are skipped, so compare deleted with requested.
Inputs: ids (required), force.
delete_media_folderDelete media folderADestructiveInspect
Delete a media folder. By default only empty folders are removed; pass deleteContents to also delete the assets inside, and force to override the refusal that protects assets still in use.
Inputs: id (required), force, deleteContents.
delete_modelDelete modelADestructiveInspect
Delete a data model. WARNING: this cascades - ALL records of the model are permanently deleted.
Inputs: idOrSlug (required).
delete_pageDelete pageADestructiveInspect
Move a page and all its descendants to the trash. The page leaves the site at once; the group stays restorable with restore_page (as unpublished drafts) for 30 days, after which it is deleted permanently. Cannot delete the homepage.
Inputs: pageId (required).
delete_page_typeDelete page typeADestructiveInspect
Delete a page type. Refused for system types and for a type any page still uses - move or delete those pages first.
Inputs: pageTypeId (required).
delete_price_listDelete price listADestructiveInspect
Delete a price list with all its fixed prices and unassign it from every company and customer it prices (see assignedCount in list_price_lists) - they pay catalogue prices from then on - and unpublish it from every sales channel it is published to (see channels). Orders keep the list name they were priced under. Cannot be undone.
Inputs: id (required).
delete_recordDelete recordADestructiveInspect
Permanently delete one record (entry) by its id. A record still used by page blocks is refused and the error lists those pages; force: true deletes it anyway and leaves those references stale.
Inputs: recordId (required), force.
delete_sales_channelDelete sales channelADestructiveInspect
Delete a sales channel and unpublish every price list from it. Its open carts are abandoned - activeCartCount in list_sales_channels / get_sales_channel says how many - and storefronts still sending its key are refused (BAD_USER_INPUT). Orders keep the channel they were placed through. Cannot be undone.
Inputs: id (required).
delete_webhookDelete webhookBDestructiveInspect
Delete a webhook endpoint permanently.
Inputs: id (required).
edit_orderEdit orderADestructiveInspect
Replace an order's line items (full replace of the items array). Recomputes totals.
Inputs: items (required), orderId (required).
get_customerGet customerARead-onlyInspect
Get one customer by id: the account summary (identity, status, verification, lock, last login, company, companyRole - the effective company role, a key of the workspace's role catalogue (v1: admin, buyer), buyer unless staff set another for the company they belong to now, null without a company - priceList (the list assigned to the customer themselves, ignored while they belong to a company), effectivePriceList (the list that prices their carts and orders: id, name, source MEMBER or COMPANY, companyName when COMPANY; null = catalogue prices) and orderStats: non-canceled order count, last order date and net spend in minor units per currency, null without orders:view) plus the profile record's data. Read-only.
Inputs: id (required).
get_discountGet discountARead-onlyInspect
Get one discount's full details by id or code: type, value, currency, minSubtotal (default currency, or a fixed code's own), minSubtotalByCurrency (per additional currency), usage limits and validity window.
Inputs: idOrSlug (required).
get_formGet formARead-onlyInspect
Get one form's full details (fields, settings, submission count) by id or slug.
Inputs: idOrSlug (required).
get_form_submissionGet form submissionARead-onlyInspect
Get one form submission's full details by its id.
Inputs: submissionId (required).
get_modelGet modelARead-onlyInspect
Get the full details of one data model by id or slug: complete field definitions (type, options, relations, validation) the product capability config (enabled, field roles incl. the resolved roles, variantAxes) the accounts config (auth: identityField, companyField - a relation to a Company model, registration - open or closed, closed means siteMember.register refuses new sign-ups, email - whether cmssy sends verification, password reset and login change emails itself (enabled, links URL templates, templates copy overrides per kind and locale; off means the app's webhook sends them); each field's memberCanSet says whether the member may change it on their own account and send it at sign-up, never for password fields or the company field) the Company capability (company: { enabled }, null when never set; a model is at most one of product, account or company) and urlPattern, the storefront route its records' url is built from (null when none). Use before update_model and when the user asks about a model's structure.
Inputs: idOrSlug (required).
get_orderGet orderARead-onlyInspect
Get one order's full details by its id: items, the full money column (subtotal, discount, shipping, tax, total - all minor units), displayMode (net or gross, how the buyer read prices), taxRoundingMethod (per_line or per_rate), taxTreatment (kind standard, reverse_charge, exempt or export - goods shipped out of the EU VAT area, or from a seller outside the EU to another country, frozen at checkout with the facts it rests on: legalNote, the text to print on the invoice, null for standard; buyerVatId, buyerVatCountry and buyerVatVerifiedAt of the VAT id that decided it; sellerCountry; shipToCountry; orders placed before it was recorded read standard), removedTax (VAT taken out of gross-stored prices on a reverse_charge, exempt or export order, minor units, 0 otherwise; total = subtotal - discount + shippingTotal - removedTax), amounts (net, tax and gross of subtotal, discount, shipping and total), the frozen discount code, channel (the sales channel the order was placed through: id, key, name; null for none), priceList / priceListName (the primary price list the order was priced from, name frozen at checkout; null when none) and priceListSource (MEMBER, COMPANY or CHANNEL - whose list it was), pricingChain (the lists tried in order: buyer, channelDated, channelBase; each null when none) - every list reference carries deleted, true once that list was deleted after the order, and each item's priceListId / priceListSource name the list that priced that line, PO number, shipping address, payment/fulfillment status, amountPaid (collected so far), balanceDue (total - amountPaid, what the buyer still owes; a refund does not change it), refundedAmount (refunded so far across every refund, minor units; left to refund = amountPaid - refundedAmount), refundedAt (when the latest refund was recorded, null when none), refundReferences (the refund references recorded, oldest first - refund_order and refund_return ignore a reference already listed), invoices (every invoice recorded, oldest first: kind invoice - at most one, the order's invoice - then its corrections of kind correction, each with number, url, provider and issuedAt; record_order_invoice adds the invoice, record_order_invoice_correction a correction), and the parcels (shipments: id, carrier, tracking number and link, status, history) - a parcel's id is what update_shipment takes - the returns (id, number, status, lines with reason and received/restocked units, return-parcel tracking, refunded amount, history) - a return's id is what the *_return tools take - and customFields, the order's custom field values by key.
Inputs: orderId (required).
get_order_pipelineGet order pipelineBRead-onlyInspect
Get the workspace order pipeline (the configurable stages orders move through).
Inputs: no named parameters.
get_pageGet pageARead-onlyInspect
Get one page's full details (blocks, layout, page type, custom fields, the SEO title/description/display name per language, and its version - pass it as expectedVersion to patch_block_content) by id or slug. Use when the user asks about a specific page's content, structure or SEO.
Inputs: idOrSlug (required), target.
get_page_typeGet page typeARead-onlyInspect
Get one page type with its full custom-field schema - the field keys, types and options that pages of this type carry in customFields, and for relation fields their relationTo / relationType. Use before writing customFields on a page, because list_page_types does not return the fields.
Inputs: pageTypeId (required).
get_price_listGet price listARead-onlyInspect
Get one price list by id with a page of its fixed prices (entries, oldest first, at most 200 per page; pass nextCursor back as after for the next page, null on the last). An entry is a fixed unit price in minor units for one product (variantKey null) or one variant of a product with variants, with its own volume breaks (tiers), its order bounds (minQuantity / maxQuantity, null = none) and its currency (an additional currency's row names it; a default-currency row reads the product's currency); recordMissing true means the product or variant was removed and the entry prices nothing - remove it with remove_price_list_entries. Filter by recordId to see one product's entries. Read-only.
Inputs: id (required), after, first, currency, +1 more.
get_product_bulk_jobGet product bulk jobARead-onlyInspect
Read a background product bulk job's status and progress, by jobId or - for the job still queued or running on a model - by modelId (jobId wins when both are given). status goes queued -> running -> completed or failed; processed of total is the progress, deleted/updated what changed, skippedCount and skipped (first 20, with reason) what a delete left in place. A failed job carries failureReason (stalled, modelUnavailable, invalidPatch, enqueueFailed, unexpected). job is null when the id is unknown or the model has no active job. Jobs run in batches of a few hundred products: check again later rather than in a tight loop.
Inputs: jobId, modelId.
get_recordGet recordARead-onlyInspect
Get one record (entry) of a data model by its id, including all its field values and status. A company record (a model with the Company capability) also carries vatId, vatCountry, vatVerifiedAt, vatVerifiedBy and taxExemptReason, null when unset (set_company_vat_id, set_company_vat_verified, set_company_tax_exemption). A product record also carries currencyPrices and variantCurrencyPrices - its prices in additional currencies, minor units, enabled false while that currency is not an additional currency (set_product_currency_prices, set_product_variants); its data holds the default-currency price. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.
Inputs: recordId (required).
get_sales_channelGet sales channelBRead-onlyInspect
Get one sales channel by id: key, name, displayMode, priceAccess, activePriceList (the dated list whose window holds now, else the base list), priceLists published to it with their windows, nextChangeAt and activeCartCount (open carts a delete would abandon). Read-only.
Inputs: id (required).
get_site_configGet site configBRead-onlyInspect
Get the workspace's site configuration: languages, site name, enabled features, and the cart/commerce settings (currency, tax rates, shipping methods, custom order fields).
Inputs: no named parameters.
get_site_setupGet site setupADestructiveInspect
Everything needed to build a website or app on this cmssy workspace: the exact files to write (catch-all page, editor route, proxy, config, block registry, header/footer layout regions), the npm packages, the env vars filled in for this workspace (CMSSY_DRAFT_SECRET included - server-only), and the steps in order. Call it first whenever you build or wire a site, instead of reconstructing the setup from documentation.
Inputs: framework.
get_workspace_infoGet workspace infoARead-onlyInspect
Get the current workspace's info: name, slug, its organization's plan and the plan limits pooled across the organization - workspaces, member seats, pages, storage, upload size, Content API requests and transfer per month, orders per month, and whether single sign-on is included. Only pages and orders can be unlimited (null).
Inputs: no named parameters.
import_recordsImport recordsADestructiveInspect
Bulk-import records into a data model (up to 1000 rows). Without upsertKey each row CREATES a record; with upsertKey (a unique field or the product SKU field) a row matching an existing record UPDATES it instead, so a repeated sync does not duplicate. A translatable field takes a language map ({ title: { en: '...', no: '...' } }); a language the workspace has not enabled is rejected. Returns importedCount (created), updatedCount, per-row errors, and per-row record ids with CREATED / UPDATED / UNCHANGED.
Inputs: rows (required), modelIdOrSlug (required), upsertKey.
list_block_typesList block typesARead-onlyInspect
List the block types available on the workspace's site, each with its content field schema and default values. Use a block type's schema to shape content for add_block_to_page / update_block_content / patch_block_content - content is language-keyed ({ en: { fieldKey: value } }), and a relation field stores record id(s) per its relationTo/relationType. A non-empty layoutRegions marks a layout block (header/footer) managed via update_page_layout, not page body blocks.
Inputs: no named parameters.
list_block_usageList block usageARead-onlyInspect
Show where each block type is stored across the workspace: draft and published page blocks, layout regions (draft and published) and developer drafts, with per-surface counts and the pages that hold it. registered says whether the active block manifest still declares the type; orphanTypes lists types stored but no longer registered (the site renders nothing for them), unusedTypes lists registered types no page uses. Use it before renaming or removing a block type in code, then migrate or remove the instances it lists with update_block_content / remove_block_from_page.
Inputs: types, includeHistory.
list_cartsList cartsARead-onlyInspect
List shopping carts (admin view) with optional status filter and pagination. totalValue is in minor units. channel is the key of the sales channel the cart was started on (null for none): a buyer has one active cart per channel.
Inputs: skip, limit, status.
list_customersList customersARead-onlyInspect
List the customers - accounts that sign in to the user's site (records of an accounts model), with status, verification, last login, their company, companyRole (the effective company role: admin or buyer in v1, null without a company), effectivePriceList (the price list that prices them, source MEMBER or COMPANY; null = catalogue prices) and orderStats (non-canceled order count, last order date, and net spend = paid minus refunded, in minor units, one entry per currency; null when the caller may not view orders). Not the team: those are list_team. Read-only; filter by model, status, company or an identity search; newest first. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter.
Inputs: skip, limit, cursor, search, +3 more.
list_discountsList discountsARead-onlyInspect
List discount codes in the workspace. Filter by enabled, type, or a code search; page on with offset while hasMore is true.
Inputs: type, limit, offset, search, +1 more.
list_email_configurationsList email configurationsARead-onlyInspect
List the workspace's email configurations: id, name, slug, description, provider, sender, default and active flags, and how many recipients each has. Pass an id as a form's emailConfigurationId in create_form or update_form. API keys, SMTP and Mailgun settings and recipient addresses are never returned here.
Inputs: includeInactive.
list_formsList formsARead-onlyInspect
List the forms in the workspace. Filter by status; page on with skip while hasMore is true.
Inputs: skip, limit, status.
list_form_submissionsList form submissionsBRead-onlyInspect
List form submissions, optionally filtered by form and status; paginated. Returns submission rows with their data and status.
Inputs: skip, limit, status, formIdOrSlug.
list_mediaList mediaARead-onlyInspect
List media files (images and files) in the workspace, newest first. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter.
Inputs: limit, cursor, offset.
list_media_foldersList media foldersARead-onlyInspect
List media folders in the workspace (optionally under a parent folder). Use this to discover a folderId before uploading or moving assets.
Inputs: parentId.
list_modelsList modelsARead-onlyInspect
List the data models (content types) defined in the current workspace. Use to answer 'do we have models / a Product model?' or to see what data structures already exist.
Inputs: no named parameters.
list_ordersList ordersARead-onlyInspect
List orders in the workspace. Filter by payment, fulfillment or delivery status, state (open/closed/canceled), customer, company (B2B), pipeline stage, warehouse queue (to pack, in transit, shipping problem, returns), a search string (customer email or company name), currency, or a date range. Each order carries customerId, companyId and companyName when it was placed for a customer or a company. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter.
Inputs: skip, limit, queue, state, +11 more.
list_pagesList pagesARead-onlyInspect
List the workspace's pages (id, name, slug, published), optionally filtered by a search string.
Inputs: search.
list_page_typesList page typesARead-onlyInspect
List the workspace's page types (templates) with their id, name, slug and url prefix.
Inputs: no named parameters.
list_price_listsList price listsARead-onlyInspect
List the workspace's price lists (Gold, Silver, dealer tiers ...), by name: each with percentOff (percent off the catalogue, 2 decimals; negative = a markup), startsAt / endsAt and active (false outside that window: the list prices nobody and its buyers pay catalogue prices), overrideCount (fixed prices it holds), assignedCount (companies and customers it prices) and channels (the sales channels it is published to, with key and priceAccess). A list prices a buyer from a fixed price per product or variant where it has one, else the catalogue price minus percentOff. Read-only; entries are in get_price_list.
Inputs: no named parameters.
list_productsList productsARead-onlyInspect
List a product model's catalog with stock and variant info (onHand/reserved/available per record and variant). A product is a record of a model whose product capability is enabled (get_model shows product.enabled and the field roles): create one with create_record on that model and change it with update_record; set_product_tiers and the bulk_* product tools work on the same records. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.
Inputs: modelId (required), sort, limit, cursor, +2 more.
list_recordsList recordsARead-onlyInspect
List the records (entries) of a data model, by the model's id or slug. Supports filtering (per key: scalar equality, $in, $gte/$lte, $regex as a literal substring match), sort, and pagination. Each record includes its full data, so you can find a record by a field value (e.g. sku) without extra lookups. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.
Inputs: modelIdOrSlug (required), sort, limit, cursor, +4 more.
list_rolesList rolesARead-onlyInspect
List the roles defined in this workspace and the permissions each one grants. Read-only. Useful for understanding who can do what.
Inputs: no named parameters.
list_sales_channelsList sales channelsARead-onlyInspect
List the workspace's sales channels (retail, horeca, b2b ...), by key. A storefront sends a channel's key to be priced from the price lists published to it: per product the buyer's own or company list wins, then the channel's dated list whose window holds now, then its base (undated) list, then the catalogue. Each channel has key (what the storefront sends, fixed once created), name, displayMode (net or gross prices for visitors and customers without a company), priceAccess (PUBLIC - anyone; MEMBERS - signed-in customers, registration is open; COMPANY_MEMBERS - buyers of an approved company), activePriceList (the list pricing it now), priceLists (every list published to it), nextChangeAt (when its prices next change) and activeCartCount (open carts on it). Read-only.
Inputs: no named parameters.
list_teamList teamARead-onlyInspect
List the team - the people who manage this workspace - with their role and status (active, suspended, or a pending invitation). Not shoppers: those are records of the customer model. Read-only; filter by status or a search string; page on with skip while hasMore is true.
Inputs: skip, limit, search, status.
list_trashed_mediaList trashed mediaARead-onlyInspect
List the media trash, newest first. Each file shows when it was deleted and when it expires; after that it is deleted permanently. A file with isPurging true is being deleted and cannot be restored. Restore with restore_media. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter.
Inputs: limit, cursor, offset.
list_trashed_pagesList trashed pagesARead-onlyInspect
List the page trash, newest first. Each entry is one deleted group - a page plus the descendants deleted with it: id (the trash id restore_page takes), name, slug, deletedAt, deletedById and deletedByName, descendantCount, and expiresAt, when the group is deleted permanently (30 days after deletion). Only groups the caller holds pages:delete on are listed; without it the list is empty.
Inputs: no named parameters.
list_webhook_deliveriesList webhook deliveriesBRead-onlyInspect
List recent webhook delivery attempts (status: pending/success/failed) for debugging.
Inputs: limit.
list_webhook_event_typesList webhook event typesARead-onlyInspect
List the event types a webhook can subscribe to (the authoritative allowlist).
Inputs: no named parameters.
list_webhooksList webhooksARead-onlyInspect
List the workspace's webhook endpoints (signing secrets are never returned here).
Inputs: no named parameters.
mark_order_paidMark order paidBDestructiveInspect
Record a full payment for an order (manual reconciliation - does NOT verify with a payment provider). amount is in minor units of the order's currency.
Inputs: amount (required), orderId (required), provider (required), reference (required).
move_mediaMove mediaADestructiveInspect
Move one or more media assets into a folder (or to the root with folderId: null). Use list_media_folders to find the destination folderId.
Inputs: ids (required), folderId (required).
patch_block_contentPatch block contentADestructiveInspect
Apply surgical edits (insert_before/insert_after/replace_section, or replace_all to set the whole string, given the value it replaces) to one string in a block's localized content without re-sending the full content - including a string nested in a list or object, via a dotted fieldPath such as 'tabs.0.label'. Each marker must match exactly once. If the result includes blockWarnings, the saved content violates the workspace block manifest (unknown field, wrong value shape, or a stored block whose type is no longer registered) - correct the content and save again, unless the warning is about a stored block whose type is no longer registered: that one is a manifest problem, so restore or sync the type, or find the block with list_block_usage and migrate or remove it. When the warnings also say when the workspace block manifest was last synced, the field or type may simply be newer than the manifest: if the site's code declares it, keep the content and sync the manifest (cmssy sync-manifest in the site's repo) instead. A block whose type the workspace block manifest does not register is refused unless the page already stores that block - pick registered types from list_block_types.
Inputs: locale (required), pageId (required), blockId (required), operations (required), +2 more.
promote_dev_draftPromote dev draftADestructiveInspect
Promote YOUR per-user dev draft overlay onto the page's shared draft (replaces the shared draft blocks; the overlay belongs to the token's user). Do this after the block code for the composed types is deployed to the site. Fails when you have no dev draft for the page. The promote is refused with DEV_DRAFT_PROMOTE_REFUSED when the dev draft introduces block warnings the shared draft does not already carry, or empties a language, the shared values or the flat content a shared-draft block holds, or leaves out a shared-draft block that holds content (it would be removed from the page); the error lists the blockWarnings and emptiedBlocks, where removed: true marks a left-out block. Fix the dev draft (update_page_blocks with target: 'devDraft') and promote again; pass force: true only after fixing is ruled out. Promoting a block whose type the workspace block manifest does not register is refused - run cmssy sync-manifest from the deployed code first.
Inputs: pageId (required), force.
publish_pagePublish pageBDestructiveInspect
Publish a page (or re-publish with the latest draft changes). Publishes both content and layout.
Inputs: pageId (required).
receive_returnReceive returnBDestructiveInspect
Record the return parcel as received: how many units of each line arrived and how many go back to stock. Stock is adjusted by the restocked units only.
Inputs: lines (required), orderId (required), returnId (required), note.
record_order_invoiceRecord order invoiceCDestructiveInspect
Attach an invoice (number, optional URL and provider) to an order.
Inputs: number (required), orderId (required), url, provider.
record_order_invoice_correctionRecord order invoice correctionADestructiveInspect
Attach a correction invoice (credit note: number, optional URL and provider) to an order that already has its invoice, e.g. after a refund. Allowed on canceled and refunded orders; the number must be new to the order.
Inputs: number (required), orderId (required), url, provider.
record_order_paymentRecord order paymentBDestructiveInspect
Record a (possibly partial) payment against an order's outstanding balance. amount is in minor units of the order's currency and capped at the balance due.
Inputs: amount (required), orderId (required), reference (required), provider.
redeliver_webhook_deliveryRedeliver webhook deliveryADestructiveInspect
Send a finished webhook delivery again. The stored payload goes out as a NEW delivery with its own id and its own retry ladder; the original row is left untouched and the new one records replayOf. A delivery that is still pending is refused.
Inputs: deliveryId (required).
refund_orderRefund orderADestructiveInspect
Refund an order. Omit amount for a full refund; pass amount (minor units of the order's currency) for a partial refund.
Inputs: orderId (required), reference (required), amount.
refund_returnRefund returnADestructiveInspect
Record a refund for a return - money already sent back at the payment provider. It counts against the order's refunds and completes a received return.
Inputs: orderId (required), returnId (required), reference (required), note, +1 more.
reject_returnReject returnADestructiveInspect
Reject a return the customer requested; it frees its items for another return.
Inputs: orderId (required), returnId (required), note.
remove_block_from_pageRemove block from pageADestructiveInspect
Remove a specific block from a page by its instance id. Works for content and layout blocks.
Inputs: pageId (required), blockId (required).
remove_price_list_entriesRemove price list entriesADestructiveInspect
Remove up to 1000 fixed prices from a price list by key: recordId alone for a product without variants, recordId + variantKey for one variant of a product with variants; currency limits a key to that currency's row, without it every currency's row goes. Those products then fall back to the catalogue price minus the list's percentOff. Returns how many were removed; a key with no entry removes nothing.
Inputs: keys (required), priceListId (required).
reopen_orderReopen orderADestructiveInspect
Reopen a closed order so it shows as work in progress again. A canceled order cannot be reopened.
Inputs: orderId (required).
resend_customer_verificationResend customer verificationADestructiveInspect
Issue a fresh verification token for a customer whose status is pending and send it as the webhook event account.verification_requested to the workspace's webhooks; when the customer's model has account emails on (get_model auth.email.enabled), cmssy also emails the customer itself. The previous token stops working and the new one lasts 24 hours. Refused for a customer who is already verified or is suspended, and after five account requests for the same customer in an hour. emailDelivery.status is cmssy's own email: SENT (handed to the email provider), FAILED (not sent - error says why, the email log lists it) or OFF (the model leaves emailing to the app). endpointSubscribed: false means no enabled webhook endpoint receives the event; with emailDelivery OFF nothing then reaches the customer.
Inputs: id (required).
restore_mediaRestore mediaADestructiveInspect
Restore media assets from the trash. Each returns to its folder, or to the library root when that folder no longer exists (counted in movedToRoot). Ids not in the trash are skipped, so compare restored with requested.
Inputs: ids (required).
restore_pageRestore pageADestructiveInspect
Restore a deleted page group from the trash: the page and every descendant deleted with it come back, all as unpublished drafts, with their content, history and ids. When the original parent no longer exists the page comes back at the top level. Refused with CONFLICT, restoring nothing, when a live page already uses one of the group's slugs (the error names the slug) or one of the pages is still live; refused with PLAN_LIMIT_EXCEEDED when the restored pages would exceed the organization's page limit. Needs pages:delete. Returns the restored root page with its published state.
Inputs: trashId (required).
revert_to_publishedRevert to publishedADestructiveInspect
Discard all draft changes and revert a page to its last published version.
Inputs: pageId (required).
rotate_webhook_secretRotate webhook secretADestructiveInspect
Rotate a webhook endpoint's signing secret. Returns the endpoint and the NEW secret (shown only once).
Inputs: id (required).
send_customer_password_resetSend customer password resetADestructiveInspect
Issue a password reset token, the same one the site's forgot-password flow issues, and send it as the webhook event account.password_reset_requested to the workspace's webhooks; when the customer's model has account emails on (get_model auth.email.enabled), cmssy also emails the customer itself. The token works for one hour. For an active customer who cannot sign in. Refused for a suspended customer, for one who has not verified yet (use resend_customer_verification), for a customer whose account model has no password sign-in, and after five account requests for the same customer in an hour. emailDelivery.status is cmssy's own email: SENT (handed to the email provider), FAILED (not sent - error says why, the email log lists it) or OFF (the model leaves emailing to the app). endpointSubscribed: false means no enabled webhook endpoint receives the event; with emailDelivery OFF nothing then reaches the customer.
Inputs: id (required).
set_company_price_display_modeSet company price display modeADestructiveInspect
Set how the buyers of a company record read prices: net (VAT added on top) or gross (VAT inside); null falls back to the default, net for a company buyer. Applies to carts started after the change; existing carts and orders keep the mode they were priced in. Refused for a record that is not a company (a model with the Company capability). Returns the record id with its priceDisplayMode and taxRoundingMethod.
Inputs: recordId (required), displayMode (required).
set_company_price_listSet company price listADestructiveInspect
Assign a price list to a company record; null unassigns. Every member of the company pays this list - one list per buyer, and a member's own list is ignored while they belong to the company. A company without a list leaves its members on catalogue prices. Refused for a record that is not a company (a model with the Company capability) - for a customer use set_customer_price_list. Returns the record id and its priceListId.
Inputs: recordId (required), priceListId (required).
set_company_tax_exemptionSet company tax exemptionADestructiveInspect
Exempt a company record's orders from VAT, or clear the exemption with null. An exempt company's carts and orders carry 0% and 0 tax with reason as the legal note, whatever its VAT id; in a workspace that stores gross prices the VAT inside them is removed, not charged. Carts already holding the old status are refused at checkout (BUYER_CHANGED) and orders keep the treatment they were placed with. Needs customers:manage and site:config:edit, the same pair as set_company_vat_verified and as linking a customer to a company whose VAT id is verified or that is tax exempt. Refused for a record that is not a company (a model with the Company capability). Returns the record id with vatId, vatCountry, vatVerifiedAt, vatVerifiedBy and taxExemptReason.
Inputs: reason (required), recordId (required).
set_company_tax_roundingSet company tax roundingADestructiveInspect
Set how VAT is rounded for the net-price buyers of a company record: per_line or per_rate; null falls back to the workspace's companyTaxRounding (update_cart_config). Gross-price buyers and consumers are always rounded per_line. Applies to carts started after the change; existing carts and orders keep the method they were priced with. Refused for a record that is not a company (a model with the Company capability). Returns the record id with its priceDisplayMode and taxRoundingMethod.
Inputs: method (required), recordId (required).
set_company_vat_idSet company vat idADestructiveInspect
Set the EU VAT id of a company record. cmssy normalizes it (spaces, dots and dashes dropped, GR read as EL) and checks it against the member state's format; a malformed id is refused (BAD_USER_INPUT). null or empty clears it. A changed id is no longer verified, so its orders are taxed as standard until set_company_vat_verified attests the new value. Needs customers:manage. Verifying the id or exempting the company (set_company_vat_verified, set_company_tax_exemption) needs customers:manage and site:config:edit, and so does linking a customer to a company whose VAT id is verified or that is tax exempt. Refused for a record that is not a company (a model with the Company capability). Returns the record id with vatId, vatCountry, vatVerifiedAt, vatVerifiedBy and taxExemptReason.
Inputs: vatId (required), recordId (required).
set_company_vat_verifiedSet company vat verifiedADestructiveInspect
Attest that a company record's VAT id was checked (for example in VIES), or withdraw that attestation. A verified EU VAT id of another member state than the workspace's sellerCountry (update_cart_config) zero-rates the company's orders as reverse charge, unless an order ships to the seller's country, or out of the EU as an export; withdrawing it taxes them as standard again. Carts already holding the old status are refused at checkout (BUYER_CHANGED) and orders keep the treatment they were placed with. Refused when the company has no VAT id (set it with set_company_vat_id) and with CONFLICT when the stored id differs from expectedVatId. Needs customers:manage and site:config:edit, the same pair as set_company_tax_exemption and as linking a customer to a company whose VAT id is verified or that is tax exempt. Refused for a record that is not a company (a model with the Company capability). Returns the record id with vatId, vatCountry, vatVerifiedAt, vatVerifiedBy and taxExemptReason.
Inputs: recordId (required), verified (required), expectedVatId.
set_customer_company_roleSet customer company roleADestructiveInspect
Give a customer a company role in the company they belong to now. Roles come from the workspace's catalogue; v1 has two: 'admin' sees every order placed for the company, 'buyer' (the default) only their own. The role holds only while the customer stays in that company - moved to another, they are buyer there. Refused when the customer has no company, and for a key outside the catalogue. Returns the customer with companyRole as the effective role.
Inputs: id (required), role (required).
set_customer_price_listSet customer price listADestructiveInspect
Assign a price list to a customer without a company (a B2C VIP); null unassigns. One list per buyer: a customer in a company pays the company's list, so assigning to them is refused - assign the list to the company with set_company_price_list instead. Returns the customer with priceList (their own) and effectivePriceList (the one that prices them, source MEMBER or COMPANY).
Inputs: id (required), priceListId (required).
set_discount_enabledSet discount enabledBDestructiveInspect
Enable or disable a discount code.
Inputs: enabled (required), idOrSlug (required).
set_order_pipeline_stageSet order pipeline stageBDestructiveInspect
Move an order to a pipeline stage (use get_order_pipeline for valid stage ids).
Inputs: orderId (required), stageId (required).
set_preview_urlSet preview urlADestructiveInspect
Point the cmssy editor at the deployed app: stores the origin of url as the workspace preview URL, the address the editor frames. Use the exact deployed origin (https://my-site.vercel.app) - a wrong host, such as an added www., leaves the editor reporting that the preview did not respond.
Inputs: url (required).
set_price_list_entriesSet price list entriesADestructiveInspect
Upsert up to 1000 fixed prices on a price list in one call (an ERP or spreadsheet import). Each row is one product (no variantKey) or one variant of a product with variants (variantKey required there), price in minor units of the row's currency (currency omitted = the default currency; an additional currency writes that currency's own row) with optional volume breaks and optional minQuantity / maxQuantity order bounds; a row replaces the whole entry already set for the same product/variant and currency, so bounds it had are cleared unless the row re-sends them (read them with get_price_list); every other entry stays. All or nothing: one invalid row refuses the whole call and the error names every bad row by index. Fixed prices override the list's percentOff. Never removes entries - use remove_price_list_entries for that.
Inputs: entries (required), priceListId (required).
set_price_list_entrySet price list entryADestructiveInspect
Set a price list's fixed price for one product, or one variant of a product with variants (variantKey required there - a list prices each variant on its own, never the product as a whole; omit it for a product without variants). currency picks the row: omitted is the default-currency row, an additional currency writes that currency's own row, which prices only carts in it. The fixed price (minor units of the row's currency, with optional volume breaks) overrides the list's percentOff for that product or variant; replaces the entry already set for it as a whole, so an existing minQuantity / maxQuantity left out of the call is cleared - read it with get_price_list and re-send it to keep it. For many rows use set_price_list_entries.
Inputs: price (required), recordId (required), priceListId (required), tiers, +4 more.
set_product_currency_pricesSet product currency pricesADestructiveInspect
Set a product's prices in the workspace's additional currencies (update_cart_config additionalCurrencies), e.g. [{currency: 'EUR', price: 4500, tiers: [{minQty: 10, price: 4000}]}]. Prices and breaks are minor units of each currency; nothing is converted from the default-currency price. price is read only while the product has no variants - a product with variants takes each variant's price from variants (here) and these tiers price every variant without breaks of its own in that currency (price null keeps just the tiers). variants sets each variant's prices per currency by its key (list_products variants[].key), e.g. [{variantKey, prices: [{currency: 'EUR', price: 4500}]}], and never touches stock, SKU or the default-currency price - this is the safe way to price variants per currency; prefer it over set_product_variants currencyPrices, which rewrites every variant's stock and SKU. A product with no price in a sales channel's currency is not sold on that channel (NO_PRICE_IN_CURRENCY). prices replaces the record's whole list: send every currency the product keeps. A variant removed while the call ran fails it with CONFLICT - re-read list_products and retry.
Inputs: prices (required), recordId (required), variants.
set_product_tiersSet product tiersADestructiveInspect
Set the record-level volume price breaks on a product (B2B quantity discounts). They price the product and every variant that defines no breaks of its own; a variant's own breaks are part of its definition, so set those with set_product_variants. A line's unit price steps down to the highest break its quantity reaches, and the cart and the order both charge that price. Prices are minor units of the default currency; breaks in an additional currency are set with set_product_currency_prices. Passing an empty array removes the breaks. increment sets the order step on the same record.
Inputs: tiers (required), recordId (required), increment.
set_product_variantsSet product variantsADestructiveInspect
Define a product's variants. Each variant is one combination of values for the model's variantAxes (set those with update_model) and carries its own price, stock, SKU and volume breaks. The call replaces the whole set, so send every variant the product keeps - a variant left out is deleted. Every field but tiers and currencyPrices is written as sent (those two are kept when omitted), so copy sku and stock (onHand) from list_products for each variant you keep; both are required, null for none. Stock already reserved by carts stays with the variant that keeps its selection. Prices are minor units: price and tiers in the default currency, currencyPrices in each additional currency (omitted = kept, like tiers). To change only prices per currency use set_product_currency_prices variants instead - it never touches stock or SKU.
Inputs: recordId (required), variants (required).
start_bulk_delete_productsStart bulk delete productsADestructiveInspect
Start a background job that permanently deletes every product matching the filter. Use it instead of bulk_delete_products when more than 1000 products match. Returns the job at once; it runs in batches, so follow its progress with get_product_bulk_job. A model runs one job at a time: if one is already queued or running the start is refused - read it with get_product_bulk_job by modelId. As with bulk_delete_products, a product still referenced by an open order or a page block is skipped; the finished job reports skippedCount and the first skipped products with their reason.
Inputs: modelId (required), filter.
start_bulk_update_productsStart bulk update productsADestructiveInspect
Start a background job that applies one patch (status, set/adjust stock, set/adjust price) to every product matching the filter. Use it instead of bulk_update_products when more than 1000 products match. Stock is whole units; price is major units of the default currency, and prices in additional currencies are left as they are. Returns the job at once; it runs in batches, so follow its progress with get_product_bulk_job. A model runs one job at a time: if one is already queued or running the start is refused - read it with get_product_bulk_job by modelId.
Inputs: patch (required), modelId (required), filter.
suspend_customerSuspend customerADestructiveInspect
Suspend a customer: blocks sign-in and ends every live session. Orders and carts stay. Refused for an account that has not verified yet or is already suspended.
Inputs: id (required).
take_over_page_lockTake over page lockADestructiveInspect
Take over the edit lock on a page another editor is holding open, so the next write (publish_page, update_page_blocks, update_page_layout, ...) is not refused with PAGE_LOCKED. The previous holder is bounced to read-only and may lose unsaved work. Needs pages:edit or pages:publish on the page.
Inputs: pageId (required).
unlock_customerUnlock customerADestructiveInspect
Unlock a customer who was locked out after too many failed sign-ins: clears the failed-attempt counter, lockedUntil and the sign-in throttle for that identity, so the next sign-in with the right password succeeds. Does not change the password and does not reinstate a suspended customer (that is unsuspend_customer, which also clears the lock).
Inputs: id (required).
unpublish_pageUnpublish pageADestructiveInspect
Unpublish a published page (toggles its published state off).
Inputs: pageId (required).
unsuspend_customerUnsuspend customerBDestructiveInspect
Let a suspended customer sign in again and clear any lockout. Refused for a customer who is not suspended.
Inputs: id (required).
update_block_contentUpdate block contentADestructiveInspect
Update a specific block's content on a page. Defaults to merging with existing content; pass mode: 'replace' to overwrite the block's whole content. Works for content and layout blocks. If the result includes blockWarnings, the saved content violates the workspace block manifest (unknown field, wrong value shape, or a stored block whose type is no longer registered) - correct the content and save again, unless the warning is about a stored block whose type is no longer registered: that one is a manifest problem, so restore or sync the type, or find the block with list_block_usage and migrate or remove it. When the warnings also say when the workspace block manifest was last synced, the field or type may simply be newer than the manifest: if the site's code declares it, keep the content and sync the manifest (cmssy sync-manifest in the site's repo) instead. A block whose type the workspace block manifest does not register is refused on the shared draft unless the page already stores that block - compose types that are not deployed yet in target: 'devDraft' and promote once the code ships; pick registered types from list_block_types.
Inputs: pageId (required), blockId (required), content (required), mode, +2 more.
update_cart_configUpdate cart configADestructiveInspect
Configure the workspace's commerce settings: default and additional currencies, whether prices include tax, tax rates, shipping methods, custom order fields, stock thresholds, cart limits, session lifetimes and the B2B toggles. Only provided fields change; arrays replace the whole list. companyTaxRounding is the workspace's VAT rounding for company buyers who read net prices (a company can override it with set_company_tax_rounding); consumers are always rounded per_line. sellerCountry and reverseChargeNote drive reverse charge: a company with a verified EU VAT id of another member state (set_company_vat_verified) pays 0% VAT and its orders carry the note. An order shipped out of the EU VAT area, or to any other country from a sellerCountry outside the EU, is zero-rated as an export for any buyer, with exportNote on the order. Nothing is converted between currencies: a sales channel sells in one of them (create_sales_channel currency), and every price in an additional currency is set explicitly (set_product_currency_prices, set_product_variants, set_price_list_entries currency, shippingMethods currencyPrices). Which models the store sells is not set here: a model is sellable when its product capability is enabled (update_model, product.enabled).
Inputs: taxRates, exportNote, orderFields, sellerCountry, +17 more.
update_discountUpdate discountADestructiveInspect
Update a discount (partial). code/type/currency become immutable once the discount has been used. A code with any minimum (minSubtotal for the default currency, minSubtotalByCurrency for additional currencies) applies only in the currencies those minimums name.
Inputs: idOrSlug (required), code, type, value, +7 more.
update_formUpdate formADestructiveInspect
Update an existing form's name, slug, status, fields or settings. Name the settings keys you are changing - the rest keep their stored values. 'fields' is the opposite: it replaces the whole array, so send every field you want the form to keep.
Inputs: idOrSlug (required), name, slug, fields, +3 more.
update_form_submission_statusUpdate form submission statusBDestructiveInspect
Update a form submission's status (pending, processed, spam, archived).
Inputs: status (required), submissionId (required).
update_media_folderUpdate media folderADestructiveInspect
Rename a media folder and/or move it under a different parent folder.
Inputs: id (required), name, parentId.
update_modelUpdate modelADestructiveInspect
Update a data model by id or slug: name, slug, description, icon, color, displayField, defaultSort, statusField, fields, product capability config, uniqueFields (replaces the whole list; refused while records already share a value), deliveryAccess ("public" lets the user's app read the model through the delivery API; "none" is admin only), or urlPattern (where its records live on the storefront, e.g. /p/{slug} - their url is built from it; null removes it). fields is a PATCH - listed fields are added or replaced by key, unlisted fields stay untouched; use removeFields to delete fields and fieldOrder (every remaining key, in order) to reorder them. product is also a PATCH of the commerce capability config (enabled, priceField, skuField, inventoryField, variantAxes) - omitted keys keep their stored values. While the product is enabled, a call that changes product, fields, removeFields or displayField is graded against every product role, and refused when one would name a missing field or a field of a type it cannot read. auth is a PATCH of the accounts config (enabled, identityField, companyField for B2B companies over customers - a relation to a model with Company enabled, registration, email, verification, lockout) - omitted keys keep their stored values, null unlinks the company. auth.registration "closed" stops self sign-up (siteMember.register refuses; admins still create accounts) - existing pending accounts can still verify their email, so suspend or delete those; "open" lets anyone sign up again. auth.email is a PATCH of the account emails cmssy sends itself: enabled true needs the workspace's default email configuration (refused without one) and the account.* webhooks still fire, so an app that mails too sends a second email; links merges URL templates by kind ({token} required, {siteUrl}, {locale}); templates replaces every copy override (call get_model first and send the full list to change one). Which fields a member may change on their own account and send at sign-up is each field's memberCanSet (registration accepts only those; password fields and the company field never). company is a PATCH of the Company capability ({ enabled }) - a model is at most one of product, account (auth) or company; turning it off is refused while an accounts model's companyField links it.
Inputs: idOrSlug (required), auth, icon, name, +14 more.
update_order_detailsUpdate order detailsADestructiveInspect
Update order metadata: customer email, internal notes, PO number, delivery address and custom order fields. Only provided fields change. A delivery address whose country would change the order's frozen tax treatment (taxTreatment in get_order, e.g. reverse_charge to standard) is refused (BAD_USER_INPUT, TAX_TREATMENT_CHANGED); cancel the order and place it again instead.
Inputs: orderId (required), notes, poNumber, customFields, +2 more.
update_page_blocksUpdate page blocksADestructiveInspect
Set the full content blocks array on a page (replaces all existing content blocks). Blocks with matching ids keep their existing content when not provided. If the result includes blockWarnings, the saved content violates the workspace block manifest (unknown field, wrong value shape, or a stored block whose type is no longer registered) - correct the content and save again, unless the warning is about a stored block whose type is no longer registered: that one is a manifest problem, so restore or sync the type, or find the block with list_block_usage and migrate or remove it. When the warnings also say when the workspace block manifest was last synced, the field or type may simply be newer than the manifest: if the site's code declares it, keep the content and sync the manifest (cmssy sync-manifest in the site's repo) instead. A block whose type the workspace block manifest does not register is refused on the shared draft unless the page already stores that block - compose types that are not deployed yet in target: 'devDraft' and promote once the code ships; pick registered types from list_block_types.
Inputs: blocks (required), pageId (required), target.
update_page_layoutUpdate page layoutADestructiveInspect
Update page-level layout: inheritance, overrides, or replace all layout blocks. If the result includes blockWarnings, the saved content violates the workspace block manifest (unknown field, wrong value shape, or a stored block whose type is no longer registered) - correct the content and save again, unless the warning is about a stored block whose type is no longer registered: that one is a manifest problem, so restore or sync the type, or find the block with list_block_usage and migrate or remove it. When the warnings also say when the workspace block manifest was last synced, the field or type may simply be newer than the manifest: if the site's code declares it, keep the content and sync the manifest (cmssy sync-manifest in the site's repo) instead. A block whose type the workspace block manifest does not register is refused unless the page already stores that block - pick registered types from list_block_types.
Inputs: pageId (required), layoutBlocks, inheritsLayout, layoutOverrides.
update_page_settingsUpdate page settingsADestructiveInspect
Update page metadata: name, slug, parent and position in the tree, display name, SEO fields and custom fields. Only the languages and fields you pass change - the ones you omit keep their current values.
Inputs: pageId (required), name, slug, order, +6 more.
update_page_typeUpdate page typeADestructiveInspect
Update a page type: name, slug, icon, url prefix, allowChildren, or its custom-field schema. Fields you omit keep their current value, EXCEPT fields, which replaces the whole schema.
Inputs: pageTypeId (required), icon, name, slug, +4 more.
update_price_listUpdate price listADestructiveInspect
Rename a price list, change its percentOff (-1000 to 99.99, 2 decimals, negative = a markup; it prices every product the list holds no fixed price for) its startsAt / endsAt window (null clears a bound), or the sales channels it is published to (channels replaces the whole set, [] unpublishes it from every channel, leave it out to keep). Fixed prices are changed with set_price_list_entry / set_price_list_entries. Carts already priced from the list keep their prices until the buyer adds again; orders keep theirs.
Inputs: id (required), name, endsAt, channels, +2 more.
update_recordUpdate recordADestructiveInspect
Update an existing record by id (from list_records). Pass data to merge field values (fields you don't pass are unchanged), status to transition the record's lifecycle state, and/or published to take it on or off the site. At least one of data/status/published is required. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.
Inputs: recordId (required), data, status, published.
update_region_settingsUpdate region settingsADestructiveInspect
Set the settings of one layout region on a page, e.g. a sidebar's width or a header's variant. Reads the page's current region settings, replaces only the named region and writes the whole list back (page.updateLayout with layoutRegionSettings, one version-guarded write); entries for regions or keys the manifest no longer declares are pruned on the way. Values are validated against the workspace layout manifest's region settings schema: an unknown region, an unknown key, or non-empty values on a region that declares no settings (such a region accepts {} only) is rejected with the backend's BAD_USER_INPUT message. Child pages inherit the region's settings unless they set their own (see get_page.resolvedRegions).
Inputs: pageId (required), region (required), values (required), expectedVersion.
update_return_trackingUpdate return trackingBDestructiveInspect
Set or correct the carrier and tracking number of the parcel the customer sends back.
Inputs: orderId (required), returnId (required), carrier, trackingNumber.
update_sales_channelUpdate sales channelADestructiveInspect
Rename a sales channel or change its displayMode, priceAccess or currency. The key cannot change. Changing the currency abandons the carts open on the channel - check activeCartCount first. Narrowing priceAccess refuses carts and checkout to buyers who no longer qualify; their carts are kept and come back if access returns. Which lists price the channel is changed on the price list (update_price_list channels).
Inputs: id (required), name, currency, displayMode, +1 more.
update_shipmentUpdate shipmentADestructiveInspect
Change a parcel's delivery status or correct its tracking. Only provided fields change; sending the stored values changes nothing.
Inputs: orderId (required), shipmentId (required), note, status, +4 more.
update_webhookUpdate webhookADestructiveInspect
Update a webhook endpoint (partial). Pass enabled to enable/disable. Pass description=null to clear it. The signing secret is not returned.
Inputs: id (required), url, events, enabled, +1 more.
upload_mediaUpload mediaAInspect
Upload a file to the workspace media library from a local path or a remote URL (max 50MB; images, video, audio, PDF and common office documents). Returns the stored asset whose url can be used in block content and record media fields.
Inputs: alt, url, tags, filePath, +2 more.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 143 tools
Descriptions are exceptionally detailed and most tools have clearly distinct resource+action purposes (e.g. return lifecycle vs order lifecycle vs block editing). A few pairs still invite confusion—mark_order_paid vs record_order_payment (full vs partial), update_page_blocks vs update_block_content/patch_block_content, and bulk_update_products vs start_bulk_update_products—but the descriptions usually resolve them.
Nearly all names follow a strict snake_case verb_noun pattern (list_/get_/create_/update_/delete_/set_/bulk_), with consistent resource nouns across domains. Minor quirks like edit_order and take_over_page_lock still fit the verb_noun shape and remain readable.
143 tools is far beyond any reasonable MCP surface; even for a full CMS+commerce platform this is extreme and will overwhelm tool selection and context budgets. Many domain areas (orders, returns, pricing, pages, blocks, media, forms) each contribute a large cluster.
Coverage is remarkably comprehensive: full CRUD/lifecycle for models, records, pages, blocks, media, forms, webhooks, orders, returns, shipments, price lists, sales channels, and products, plus bulk/background jobs. Minor gaps remain (e.g. no delete_discount, email configurations are list-only), but agents can mostly work around them.
Maintenance
Related MCP Connectors
Website localization, multilingual SEO, and automated content translation for AI agents.
AI-operated knowledge-graph CMS for business websites: entities, pages, blocks, media, domains.
Manage FireCMS Cloud from an AI agent: Firestore data, collections, schemas and users.
Create, edit, preview, publish, and manage web pages from MCP-capable AI clients.
Related MCP Servers
- FlicenseNot gradedqualityNot gradedmaintenanceEnables comprehensive management of Storyblok CMS through natural language interactions. Supports story creation and publishing, asset management, component schema updates, release workflows, and content discovery across all major Storyblok APIs.8 npm-
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to interact directly with Strapi v5 CMS content through full CRUD operations, media uploads, and content type exploration using Strapi's Document Service API.591 npm1MIT
- FlicenseNot gradedqualityNot gradedmaintenanceProvides AI agents with full access to Strapi 5.x CMS for managing content types, entries, media, and schemas. It supports full CRUD operations, relation management, and secure authentication for comprehensive content administration.-
- AlicenseAqualityNot gradedmaintenanceEnables AI agents to manage Contentrain CMS content, models, and assets with automatic git branch synchronization across different environments. It provides standardized tools for performing CRUD operations on git-based headless CMS projects through natural language.14-