Get pipeline

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safe read nature is clear. The description adds that the pipeline includes jobs, durations, and failure reasons, but does not disclose behaviors like default values for include_variables or response structure. This is minimal but not contradictory.

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 short sentence, extremely concise and front-loaded. It contains no redundant words and quickly conveys the core content of the tool.

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?

For a tool with four parameters and no output schema, the description is sparse. It does not describe the return format, the effect of include_variables, or the project_id fallback behavior. It gives only a high-level idea, which is insufficient for complete understanding.

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 coverage is 50%: project_id and include_jobs have descriptions, but pipeline_id and include_variables do not. The description implies include_jobs behavior via 'with its jobs' but does not explain pipeline_id or include_variables, adding limited meaning beyond the schema.

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 'A pipeline with its jobs, durations and failure reasons' indicates the tool returns a single pipeline with its associated data, clearly distinguishing it from list_pipelines which returns multiple pipelines. However, it lacks an explicit verb like 'retrieves' or 'gets', relying on the title and tool name to convey action.

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 usage guidance is provided. The description does not state when to use this tool versus alternatives like gitlab_get_job or gitlab_list_pipelines, nor does it mention prerequisites or context such as needing a specific pipeline_id.

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