patch_note

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

Describes mutation (replaces) and returns replacement count. However, with no annotations, it lacks explicit disclosure of destructive nature, permission requirements, or behavior on multiple matches without replaceAll.

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: first covers purpose and required inputs, second provides return format and best practice. No unnecessary words.

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?

Complete for a simple tool with 100% schema coverage. Covers input, output, and usage tip. No gaps.

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?

Adds meaning beyond schema by explaining parameter roles: oldString as target, newString as replacement, replaceAll as optional boolean. Also specifies return structure, compensating for missing output 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?

Clearly states 'Replaces a string within a note', which is a specific verb+resource action. Distinguishes from siblings like write_note (overwrites) and update_frontmatter (metadata).

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?

Advises to 'Read the note first to confirm the exact string', indicating preparation before use. Does not explicitly list alternatives or when not to use, but context of sibling tools provides implicit guidance.

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