edit_note

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

Discloses failure conditions and replacement behavior. Without annotations, description carries full burden; it adequately warns about ambiguity and strict matching.

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 sentences, front-loaded with verb and method, no redundant words. Every sentence serves a purpose.

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?

Despite no output schema or annotations, description covers key behavioral aspects (failure, replacement). Could mention if operation is reversible or return value, but adequate for simple edit.

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 covers all parameters with descriptions, but description adds context on failure conditions and exact replacement semantics, beyond what schema provides.

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?

Description specifies exact string replacement, clearly distinguishing from sibling tools like update_frontmatter (metadata) and append_note (appending). Verb+resource+method are specific.

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?

Indicates failure conditions (old_text not found, ambiguous without replace_all), guiding when to use the replace_all parameter. No explicit exclusion of siblings, but context is clear.

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