block.replace

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

No annotations provided, so description carries full burden. Discloses mutation behavior, preserving ^id, and hash requirement. Lacks details on failure modes, permissions, or side effects beyond the basic workflow.

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

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

Two concise sentences with no superfluous information. First sentence defines purpose and behavior, second gives a critical prerequisite.

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

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

No output schema, so description should hint at return value but does not. Missing explanation of dry_run and other parameters. Core behavior is covered, but several contextual details are omitted.

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

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

Schema has 0% description coverage with 6 parameters. Description explains blockId as ^id reference and expected_block_hash as from block.find, but does not clarify file, vault, content format, or dry_run behavior.

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

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

Clearly states it replaces a structural block (paragraph/list-item/table-row/etc.) referenced by ^id and preserves the marker. Distinguishes from siblings like file.replace and block.find by specifying the target is a structural block.

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

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

Explicitly requires expected_block_hash from block.find, indicating a prerequisite workflow. Mentions preserving ^id marker, but does not provide explicit when-not-to-use or alternative tools.

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