Append Block

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

With no annotations, the description must provide all behavioral context. It mentions placement and strict validation but fails to disclose write semantics, permissions, side effects, or error behavior. 'Append' implies creation but lacks detail.

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?

Single sentence with 12 words, front-loading the main action and key differentiators. Every part earns its place with no fluff.

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?

Given 31 parameters, nested objects, and no output schema, the description is too terse. It omits return value, strict validation behavior, and placement semantics, leaving gaps for an AI agent to fully understand the tool.

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 94%, so the schema already explains most parameters. The description adds context about canonical types, legacy aliases, placement, and strict validation, providing marginal value beyond the schema.

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 the tool appends document blocks, naming canonical types and legacy aliases, and highlights placement and strict validation. It differentiates from siblings like append_paragraph (simpler) and append_markdown (conversion-based).

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?

No explicit guidance on when to use append_block versus other block-related siblings (e.g., append_paragraph, append_semantic_section). The description lacks 'use this when' or 'alternatives' context.

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