update_merge_request

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

Without annotations, description should fully disclose behavior. It only says 'update' and lists return fields, but doesn't specify if fields are overwritten, required permissions, or side effects.

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?

Description is concise with clear Args/Returns sections, front-loaded with purpose. Could be slightly shorter but not verbose.

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 main purpose and parameters, includes return structure. Lacks usage context like typical fields to update or limitations. Adequate but not comprehensive.

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?

Input schema has no descriptions (0% coverage), so description adds meaning: e.g., 'mr_id' is 'The merge request/pull request ID', 'kwargs' is 'Update parameters (title, description, state, etc.)'.

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 clearly states 'Update a merge request' and lists examples like title/description. Distinguishes from siblings such as create_merge_request and close_merge_request.

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 vs. alternatives like create_merge_request or close_merge_request. Does not mention prerequisites or when not to use it.

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