get_merge_request_diff

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

No annotations are provided, so the description carries the full burden. It discloses the return format (dict with keys like mr_id, total_changes, files, diff_format, truncated), which is good. However, it does not mention whether this is a read-only operation, permission requirements, or potential truncation behavior in detail.

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 well-organized with Args and Returns sections. It is informative but slightly verbose; each sentence contributes value. Could be more concise by omitting the redundant returns section if already covered by output schema.

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?

The description provides a detailed return structure and parameter explanations. However, the mismatch between schema and description for the options parameter creates a gap. Additionally, there is no mention of pagination or handling of large diffs. Given the complexity, it is adequate but not complete.

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 description coverage is 0%, so the description must add meaning. It explains platform, project_id, mr_id, and options (including sub-options like format and include_diff). However, there is a contradiction: the schema defines options as a required string, while the description treats it as optional keyword arguments (dict-like). This inaccuracy reduces reliability.

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 'Get diff/changes for a merge request', using a specific verb and resource. It distinguishes from sibling tools like get_merge_request_details and get_merge_request_commits.

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 explains what the tool does but does not provide guidance on when to use it versus alternatives, nor does it mention prerequisites or exclusions. The usage is implicit from the context.

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