Skip to main content
Glama

Update a block

update_block
Read-only

Replace the data of one block. Send the complete data object for the block type.

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": {
      "document": "<document>",
      "blockId": "<blockId>",
      "data": "<data>"
    },
    "name": "update_block"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYesThe complete new block data.
blockIdYesThe id of a block in the document.
documentYesThe Publisle document: an object with schemaVersion and blocks, as returned by the other tools.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior1/5

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

The description describes a write operation that replaces block contents, yet the annotations declare readOnlyHint=true. This is a direct conflict about whether the tool mutates state, and the description offers no compensating detail on reversibility or side effects.

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?

Two short sentences with no filler, and the replacement semantics are front-loaded before the input requirement. Every sentence carries information.

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

Completeness2/5

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

For a mutation tool with a nested, polymorphic 'data' object whose shape varies by block type, the description says nothing about how to construct that object or what a valid document looks like beyond a one-line schema note. It also leaves the read-only contradiction unresolved, giving an agent no reliable basis for deciding whether calling it is safe.

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

Parameters3/5

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

Schema coverage is 100%, so all three parameters (document, blockId, data) are documented in the schema itself. The description adds only the emphasis that data must be the complete object, not a partial patch, which is a marginal but real addition. Baseline 3 is appropriate.

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

Purpose4/5

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

"Replace the data of one block" gives a specific verb (replace) and resource (block), which is clearer than a generic "update". It does not distinguish itself from siblings like duplicate_block or move_block, but the operation is unambiguous on its own.

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

Usage Guidelines2/5

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

The only guidance is "Send the complete data object for the block type," which is a usage constraint rather than a when-to-use rule. Nothing says when to choose this over move_block, duplicate_block, or remove_block, nor what prerequisites exist (e.g., a valid blockId from list_blocks).

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