Compare Pipeline Runs

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, covering the safety profile. The description adds only that it 'highlights differences', which is a natural consequence of comparing. It does not disclose pagination, rate limits, or output format behavior beyond the schema, so the added value is minimal.

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 a single 12-word sentence, very concise and front-loaded with the verb and resource. However, it is perhaps overly brief for a tool with multiple parameters, sacrificing completeness for brevity.

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 the tool's moderate complexity (3 required parameters, one optional enum) and lack of an output schema, the description is insufficient. It does not explain the return format (e.g., what 'structured' or 'markdown' outputs look like) or the meaning of 'added, removed, changed jobs' in detail. Contextual completeness is low.

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%, and the description provides no explanation of any parameter. The parameter names (project_id, left_pipeline_id, right_pipeline_id, output_format) are self-explanatory, but the description fails to clarify the meaning of output_format values ('structured' vs 'markdown') or any constraints beyond those in the schema. This is a significant gap for a tool with four parameters.

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 specifies the verb 'compare' and the resource 'pipeline runs', and states the output scope ('added, removed, or changed jobs'). It effectively distinguishes this from sibling tools that retrieve single pipelines (gitlab_get_pipeline) or list pipelines (gitlab_list_pipelines).

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 implies usage for comparing two specific pipeline runs but provides no explicit guidance on when to use this tool versus alternatives like gitlab_compare_refs or gitlab_get_merge_request_pipelines. No exclusions or context about prerequisites are mentioned.

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