Skip to main content
Glama

update_record

Destructive

Replace a record's document with a new revision, normally published immediately (full-document replace, not a partial patch). data must match the collection schema (see describe_resource). In a collection with screening, the new revision may become readable only after screening (published: false, delivery: "pending"). Requires the UPDATE permission on this API.

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": {
      "collection": "<collection>",
      "record_id": "<record_id>",
      "data": "<data>"
    },
    "name": "update_record"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYesFull replacement document matching the schema.
parentsNoParent placeholders for nested collection resource_ids.
record_idYesresource_key of the record to replace.
collectionYesCollection resource_id from discover_resources.
expected_revisionNoOptional. Apply the write only if the record's current revision is still this one -- pass the `_sys.revision` value from the record you read. Prevents silently overwriting another writer's update; returns precondition_failed if the record moved on.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered; the description goes well beyond that by explaining exactly what gets destroyed (the whole document is replaced, not merged), the screening side effect with concrete field values (published: false, delivery: "pending"), the permission prerequisite, and a specific failure mode (precondition_failed). This is unusually rich disclosure for a mutation tool.

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

Conciseness5/5

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

Three compact sentences, front-loaded with the core operation and the replace-vs-patch distinction, followed by the screening caveat and the permission requirement. Parenthetical clarifications are short and every clause carries information an agent needs; nothing is restated from the schema.

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 destructive write with no output schema, the description covers the critical unknowns: validation source, permission requirement, screening effect on readability, and optimistic-concurrency failure. The only gap is that it does not say what the call returns on success (e.g. the new revision identifier), which matters since no output schema exists.

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 a useful routing instruction for the most important parameter: `data` must match the collection schema, with describe_resource named as the way to learn it. The expected_revision concurrency semantics are already fully documented in the schema, so the description correctly does not repeat them.

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 opens with a specific verb and resource ('Replace a record's document with a new revision') and immediately disambiguates the semantics with 'full-document replace, not a partial patch', which separates it from a hypothetical patch-style sibling and from create_record. An agent can identify the operation and its scope without opening the schema.

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 states the operating conditions clearly: normally published immediately, but in a screened collection the new revision may be readable only after screening. It also names the required UPDATE permission and points to describe_resource for the collection schema. What it lacks is an explicit statement of when not to use it (e.g. creating a new record vs. replacing an existing one), leaving that to inference from sibling names.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources