set_block_note

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

Without annotations, the description transparently explains the tool's behavior: it sets a note that is 'sticky' and visible at the top of the block. It discloses the note's persistence and role. For a simple set operation, this is sufficient.

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?

The description is two well-structured sentences followed by examples. It is front-loaded with the action and location, and every sentence serves a clear purpose without 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?

Given the tool's simplicity (three scalar parameters, no output schema), the description fully covers what the tool does and how to use it. It provides enough context for correct invocation without missing details.

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% with each parameter described. The description adds value by explaining the note's purpose and providing concrete examples of acceptable content, clarifying the expected usage beyond field descriptions.

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 sets a sticky editorial note on any block, specifying the exact location and purpose. It uniquely identifies this tool among siblings, as no other sibling tool performs this specific function.

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?

The description explicitly states the use case: 'for usage guidance, rules, or context that applies to the whole block.' It provides examples of content, implying when to use it. It does not explicitly exclude scenarios, but the context is clear enough.

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