blocks

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

Annotations indicate readWrite and non-destructive, but description adds critical behavioral details: limitations on update (text blocks only), signed URL expiry for image/file blocks, and position parameter behavior. No contradiction with annotations.

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?

Brief summary followed by structured action list with parameter notes, then targeted edge cases. Every sentence adds value, no redundancy.

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?

Covers key behaviors and limitations, but lacks description of output structure (e.g., block object format) and pagination for 'children' action. Since no output schema exists, this omission reduces completeness for an AI agent.

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 coverage is 100%, but description adds nuance: clarifies 'content' as Markdown, explains 'position' enum values in detail ('start' means prepend, 'end' default, 'after_block' requires after_block_id). Provides action-specific parameter requirements.

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?

The description clearly states 'Read and modify block-level content within pages' and lists actions. It differentiates from sibling tools by advising to use 'pages' for page metadata and noting that page IDs are valid block IDs.

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?

Provides explicit alternative ('Use pages for page metadata/properties') and behavioral constraints ('update only works on text blocks', 'Image/file blocks contain signed URLs (1h expiry)'). Lacks explicit 'when not to use' but covers important context.

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