Skip to main content
Glama

Update document block

doc_update
Destructive

Replace the Markdown of one block of a docs artifact (needs edit role or higher). The first block of markdown keeps blockId, extra blocks get fresh ids right after it, and an empty string deletes the block. Pass askId to answer an open ask in the same step; an already answered ask fails with conflict. Returns { id, rev, blockIds }.

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": {
      "id": "<id>",
      "blockId": "<blockId>",
      "markdown": "<markdown>"
    },
    "name": "doc_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
askIdNo
blockIdYes
markdownYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the destructiveHint=true annotation by disclosing the permission requirement, the blockId retention/fresh-id behavior for split blocks, the empty-string deletion semantics, the conflict failure when the ask is already answered, and the return shape. These are exactly the traits an agent cannot infer from structured fields.

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 dense sentences, each carrying distinct information: the core action plus permission, the block-splitting rules, then askId and return value. Front-loaded with the verb and resource, no filler.

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 mutation with no output schema, the description covers permissions, deletion semantics, block id behavior, conflict handling, and even the return shape. Nothing an agent needs to invoke it safely is missing.

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 0%, so the description carries the burden, and it does most of it: markdown (empty string deletes, may split into multiple blocks), blockId (kept for first block, new ids follow), and askId (answers an ask, conflict on already-answered). The `id` parameter is only implicitly defined as the docs artifact identifier, leaving a small gap.

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 the Markdown of one block of a docs artifact' — with block-level scope that separates it from whole-file siblings like edit_file and write_files. An agent can identify the operation 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?

Gives clear conditions: requires edit role or higher, empty string deletes the block, and askId answers an open ask in the same step. It does not explicitly name alternatives (edit_file, write_files, create_artifact) or state when not to use this tool, so it falls short of a 5.

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