Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

Update record

update_record
Destructive

Update an existing record by id: merge field values, transition lifecycle status, or publish/unpublish it. Use for targeted edits that leave unchanged fields intact.

Instructions

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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "recordId": "<recordId>"
    },
    "name": "update_record"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataNoThe field values to change, keyed by the model's field keys. Merged into the record's current data - fields you don't pass are unchanged. A translatable field (localized: true on the model) takes a language map, e.g. { title: { pl: 'Łożysko' } }; the languages you don't pass are kept, so you can add one translation without resending the others.
statusNoNew status value to transition the record to (validated against the model's statusField transitions).
recordIdYesThe record's id (from list_records)
publishedNoPublish (true) or unpublish (false) the record. An unpublished record stays off every public read - lists, relations, prices, cart - until published again. Separate from status, which is only a workflow label.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.73.2
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / published
      Added value: +{
      +  "description": "Publish (true) or unpublish (false) the record. An unpublished record stays off every public read - lists, relations, prices, cart - until published again. Separate from status, which is only a workflow label.",
      +  "type": "boolean"
      +}
    • addedInput schema / required
      Added value: +[
      +  "recordId"
      +]
  2. First observedv0.73.1

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the destructiveHint annotation, the description discloses merge semantics for data, lifecycle transition behavior for status, and the public visibility effect of published. It also explains that url is server-built and lists the exact conditions under which url is null, which is substantial behavioral context.

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?

The core action and required-input rule are front-loaded, and the url guidance is relevant to correct use. The url/null explanation is somewhat long, but it is structured and each part addresses a real ambiguity.

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

Completeness5/5

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

For a destructive update tool with no output schema, the description covers mutation semantics, required inputs, publish behavior, and the important server-generated url return value. It gives an agent enough information to call the tool correctly and interpret the url field.

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 an important constraint not encoded in the schema: at least one of data/status/published must be supplied. It also clarifies that data is merged rather than replaced and that published is separate from status.

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 states a specific verb and resource: update an existing record by id, with the id sourced from list_records. It also names the three mutation surfaces (data, status, published), making the tool's scope clear against create/delete siblings.

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

Usage Guidelines4/5

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

It gives clear usage constraints: at least one of data/status/published is required, and it explains when to use the returned url versus when to explain why url is null. It does not explicitly compare against bulk_update_records or other update siblings, so it stops short of full alternative routing.

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

Deploy Server

Other Tools