Skip to main content
Glama

Traceable

Update block

traceable_block_update
DestructiveIdempotent

Replace one block. Identify it by its TraceID (itemId, e.g. FR-003) or by its [[row N]] anchor (atOrder — must come from a read issued after the last insert; inserts renumber later rows). trmContent must parse to exactly one block; page/section breaks in it replace the row's break flags. TraceID renames are not supported — use traceable_trace_id_rename.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemIdNoTraceID of the block to replace
atOrderNoRow order of the block to replace (the [[row N]] anchor)
documentIdYesThe document UUID
trmContentYesTraceable Markdown (TrMD). GitHub-flavored Markdown plus [[directive]] blocks — see traceable_capabilities. Read-only annotations ([[row]]/[[document]]) are rejected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

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 idempotentHint=true, and the description adds non-obvious behavior: page/section breaks in trmContent replace the row's break flags, trmContent must parse to exactly one block, read-only [[row]]/[[document]] annotations are rejected, and inserts renumber later rows (invalidating stale anchors). This is substantial context beyond the annotations.

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?

Four dense sentences with no filler; the core action and identification keys are front-loaded, and the caveats (renumbering, break flags, rename routing) each carry distinct operational value.

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, non-open-world mutation with full schema coverage and no output schema, the description covers identification, content constraints, and side effects well. It leaves ambiguous whether itemId and atOrder are alternatives or must be combined, which matters since neither is required.

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 baseline is 3, but the description adds real meaning: itemId format example (FR-003), the atOrder staleness rule tying it to a post-insert read, and the constraint that trmContent parses to exactly one block. It does not clarify the either/or relationship between itemId and atOrder, which is not marked required.

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?

States a specific verb and resource ('Replace one block') and immediately specifies the two identification keys (TraceID or [[row N]] anchor). It also names the sibling it is not for renames (traceable_trace_id_rename), so an agent can distinguish it from traceable_block_write/delete/write without opening schemas.

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?

Gives clear selection guidance between the two identification methods and routing to traceable_trace_id_rename for renames. It also warns that atOrder must come from a read issued after the last insert. It does not explicitly say when not to use this tool versus traceable_block_write, but context is otherwise strong.

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