Delete Merge Request Note

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

Discloses permanent deletion and irreversibility, aligning with destructiveHint annotation. Adds context beyond annotations about required parameters and pre-checks.

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 tight sentences, front-loaded with action and irreversibility, then requirements and guidance. 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?

Covers essential behavioral and usage details for a simple delete tool. Lacks error handling or project_id explanation, but sufficient for typical use.

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?

Mentions two required parameters but ignores optional project_id. With 0% schema description coverage, description should explain all parameters; missing project_id leaves ambiguity.

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?

Specifically states 'Delete a top-level MR note permanently', clearly identifying the verb (delete) and resource (top-level MR note). Distinguishes from sibling tools like gitlab_delete_merge_request_discussion_note.

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?

Explains irreversibility, required parameters (merge_request_iid and note_id), and recommends pre-check tools. Could explicitly state when not to use, but provides good context.

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