gitlab_get_pipeline

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

With no annotations, the description must carry behavioral disclosure, and 'Gets' plus 'GET /pipelines/:pipeline_id' clearly indicate a read-only operation. It does not mention edge behaviors such as 404 handling, required permissions, or whether the full pipeline object is returned. For a simple GET operation, this is acceptable but 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 sentence with no wasted words, using a standard verb-resource form plus the endpoint. It is front-loaded and efficient. It is so terse that it sacrifices helpful context, but for a simple GET operation the brevity is not inappropriate.

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 tool has no output schema, no annotations, and sits among many GitLab siblings with overlapping concepts, yet the description provides only minimal GET semantics. It does not explain when to choose this over list_pipelines or get_pipeline_jobs, nor how to obtain a valid pipelineId. This is not complete enough for confident selection and correct invocation.

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?

Only one of the two parameters (projectId) has a schema description, and the tool description adds no parameter-level detail. pipelineId is only typed as a positive integer with no hint about where it comes from or how it relates to the project. The endpoint placeholder offers slight context, but it is insufficient compensation for the incomplete schema coverage and the description's silence on parameter meaning.

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 identifies the action ('Gets') and resource ('a pipeline'), and the endpoint path confirms the specific API call. It is distinct from list_pipelines, which retrieves multiple pipelines, and from pipeline-related siblings like gitlab_get_pipeline_jobs. However, it does not explicitly differentiate itself from these siblings in the text.

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 about when to use this tool versus gitlab_list_pipelines, gitlab_get_pipeline_jobs, or other GitLab siblings. There are no exclusions, prerequisites, or context cues beyond the bare GET semantics. An agent must infer usage from the tool name alone.

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