stub

Save product

save_product

Create or update the catalogue PRODUCT itself (name, price, account); for a size, colour or other option of an existing product, use save_variant. Pass an id to update that product; omit id to create a new one. Returns the new product id on create. To create/update many at once, send an items array — one all-or-nothing transaction with a single ledger recompute; each item with an id updates, each without creates.

Input Schema

Name	Required	Description
`id`	No	Product id. Present → update that product; omit → create a new one.
`sku`	No	Stock-keeping unit / product stock code. Canonical product-level SKU (mirrors a variant's sku).
`cost`	No	Cost price per unit.
`name`	No	Display name / description of the product.
`unit`	No	Legacy unit-of-measure label; prefer `units`.
`image`	No	Product image URL; pass "$delete" to remove the existing image.
`items`	No	Vector of product objects to create/update in one all-or-nothing batch. Preferred over repeated calls. Each item with an id updates; each without creates.
`notes`	No	Free-text notes.
`price`	No	Selling price per unit, in the record's currency.
`units`	No	Unit of measure label (e.g. "each", "hour", "kg").
`amount`	No	Unit amount before quantity/tax, in the record's currency.
`starred`	No	Whether the product is starred/favourited.
`archived`	No	Archive (true) or unarchive (false) the product. An archived product is kept with its history and still listed; it is not deleted.
`currency`	No	ISO 4217 currency code (e.g. "ZAR", "USD"). Defaults to the business currency.
`quantity`	No	Number of units.
`trackstock`	No	Whether stock levels are tracked for this product.
`description`	No	Product description.
`paymentlink`	No	Whether an online payment link is enabled for this product.
`salestaxids`	No	Sales tax ids to link to this product.
`unlinktaxes`	No	Sales tax ids to unlink from this product.
`costcurrency`	No	ISO 4217 currency code for the cost price.
`allowoversell`	No	Whether the product can be sold beyond available stock.
`enablequantity`	No	Whether the buyer can choose a quantity for this product.
`requireaddress`	No	Whether a delivery/billing address is required when this product is purchased.
`stocklocationid`	No	Default stock location id for new stock moves: "2" (main) or one of the business's locations. Pass "$delete" to clear it.
`salestaxexclusive`	No	Whether the price excludes sales tax.

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedNov 6, 2026

addedInput schema / properties / archived

Added value: +{
+  "description": "Archive (true) or unarchive (false) the product. An archived product is kept with its history and still listed; it is not deleted.",
+  "type": "boolean"
+}

addedInput schema / properties / items / items / properties / archived

Added value: +{
+  "description": "Archive (true) or unarchive (false) the product. An archived product is kept with its history and still listed; it is not deleted.",
+  "type": "boolean"
+}

addedInput schema / properties / items / items / properties / stocklocationid

Added value: +{
+  "description": "Default stock location id for new stock moves: \"2\" (main) or one of the business's locations. Pass \"$delete\" to clear it.",
+  "type": "string"
+}

addedInput schema / properties / stocklocationid

Added value: +{
+  "description": "Default stock location id for new stock moves: \"2\" (main) or one of the business's locations. Pass \"$delete\" to clear it.",
+  "type": "string"
+}

Changed2 schema fields changedSep 11, 2026

addedInput schema / properties / items / items / properties / sku

Added value: +{
+  "description": "Stock-keeping unit / product stock code. Canonical product-level SKU (mirrors a variant's sku).",
+  "type": "string"
+}

addedInput schema / properties / sku

Added value: +{
+  "description": "Stock-keeping unit / product stock code. Canonical product-level SKU (mirrors a variant's sku).",
+  "type": "string"
+}

First observedSep 7, 2026

TDQS

A4.5/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint=false and destructiveHint=false, so the description carries the rest: it discloses that create returns the new product id, and that the `items` path is one all-or-nothing transaction with a single ledger recompute. That transactionality and side-effect detail is genuinely useful beyond the annotations, though permission requirements and failure behaviour are not covered.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with the core purpose and the sibling distinction, then the id rule, then the batch rule. Dense but every sentence carries information; the batch sentence is slightly long but earns its length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 26-parameter tool with no output schema, the description covers the critical decision points (create vs update, single vs batch, product vs variant) and states the return value on create. Remaining gaps are minor given the fully documented schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning on top: the create-vs-update semantics of `id` and the per-item id/no-id behaviour inside `items`. It does not explain the many boolean flags, but the schema already documents those.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ('Create or update the catalogue PRODUCT itself') and explicitly scopes it against the sibling save_variant for sizes/colours/options. An agent can distinguish the two without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit routing rules: use save_variant for options of an existing product, pass `id` to update, omit `id` to create, and use the `items` array for bulk instead of repeated calls. When-to-use and when-to-use-something-else are both stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All stub tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?