get_pipeline_job

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

No annotations are provided, so the description carries the full burden of behavioral disclosure, and it does not meet that burden. It claims to return job 'details' while the schema's limit/offset parameters describe skipping lines from the end of a log — an internal inconsistency that the agent cannot resolve. Nothing discloses that output is paginated, that all parameters are optional, or whether the response contains job metadata, log trace, or both.

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 one compact sentence with no filler, which keeps it appropriately short. The word 'number' is awkward ('a GitLab pipeline job number') and the sentence is too terse to add distinguishing value, but it is not bloated.

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?

With no output schema, the agent has no way to know what the tool returns. The log-line limit/offset semantics are unexplained at the description level, there is no mention that zero parameters are required, and the relationship to get_pipeline_job_output is unspecified. For a four-parameter tool with an internal semantic mismatch, this is too thin.

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 100%, so the baseline of 3 applies — the schema already documents all four parameters clearly. The description itself adds no parameter-level meaning and does not reconcile the log-oriented limit/offset parameters with the 'details' framing, but the structured data is adequate.

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 states a specific verb and resource ('Get details of a GitLab pipeline job'), so the headline intent is readable and not a tautology. However, it does not distinguish this tool from the sibling get_pipeline_job_output, and the phrase 'job number' is imprecise. The schema's limit/offset parameters describe retrieving log lines, which suggests the tool returns more than 'details' — leaving the actual scope ambiguous.

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 gives zero guidance on when to use this tool versus overlapping siblings such as list_pipeline_jobs, get_pipeline_job_output, or get_pipeline. An agent must infer the log-tail behavior from the schema alone, and no exclusions or prerequisites are stated.

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