update_epic_note

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

With readOnlyHint=false, the description needs to add behavioral context. It does so by disclosing the dry_run=true default, which is crucial for safe use. It correctly implies mutation without contradicting 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?

The description is extremely concise: two sentences delivering the core action and two key usage tips. No fluff, front-loaded with purpose, and every sentence earns its place.

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?

For a simple update tool with three parameters and no output schema, the description covers the main action and provides critical context (how to get note_id, dry run mode). It is nearly complete, though it could mention that updates are permanent only when dry_run is false.

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%, so baseline is 3. The description adds value by advising 'Get note_id from list_epic_notes' for the note_id parameter, and restates the dry_run default, which reinforces schema info and provides practical usage hints.

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 verb 'Edit' and the resource 'existing epic note', distinguishing it from sibling tools like add_epic_note (create) and delete_epic_note (remove). It also tells how to obtain the note_id, reinforcing its specific role.

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 gives contextual guidance: 'Get note_id from list_epic_notes' and notes the dry_run default. However, it does not explicitly state when not to use this tool or compare it alternatives, leaving a minor gap.

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