Get Merge Request Diffs

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

Annotations already declare the tool as read-only, idempotent, and non-destructive. The description 'Get MR diffs with changed files' adds no behavioral context beyond what annotations provide. It does not mention pagination, response format, or any constraints.

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 at 5 words, but this brevity sacrifices essential information. While it is front-loaded, it is under-specified for a tool with 4 parameters and no schema descriptions.

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?

Given no output schema and 0% schema description coverage, the description should provide a clear picture of what the tool returns and how to invoke it. It only states it gets diffs with changed files, leaving out details like return structure, supported views, and parameter formats. This is insufficient for an agent to use the tool correctly without additional context.

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 explain parameters. It does not mention any parameter, including the required 'merge_request_iid' or the optional 'view', 'project_id', and 'excluded_file_patterns'. The agent gains no insight into how to use these parameters correctly.

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 verb 'Get' and resource 'MR diffs', matching the tool name. However, it does not differentiate from the sibling tool 'gitlab_list_merge_request_diffs', which may cause confusion. The addition 'with changed files' adds slight specificity.

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 is provided on when to use this tool versus alternatives like 'gitlab_get_merge_request_file_diff' or 'gitlab_list_merge_request_diffs'. The description lacks context for selecting this tool over siblings.

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