update_merge_request_note

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

Description only says 'modify' without disclosing behavioral traits such as permissions needed, reversibility, side effects, or response. Annotations provide only openWorldHint, so more context is expected but absent.

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, zero fluff. Efficient and to the point with no wasted 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?

No output schema, no mention of return value or error conditions. For a mutation tool requiring 4 parameters, description fails to provide necessary context about results or validation.

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 4 parameters with descriptions. The description adds no extra meaning beyond the schema, resulting in baseline score for high coverage.

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 action (modify) and target (existing merge request note). It distinguishes from create and delete siblings, but does not differentiate from the similar 'update_merge_request_discussion_note' sibling.

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 guidance on when to use this tool versus alternatives like create or delete operations. No prerequisites or contextual triggers provided.

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