Check GitLab Pipeline

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

Annotations already declare readOnlyHint=true and destructiveHint=false, establishing a safe read-only operation. The description adds valuable context by specifying the return payload, including 'bounded trace diagnostics', which hints at a limit on trace length. It does not contradict any annotations.

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, well-structured sentence that front-loads the action and resource, then lists the specific output fields. It is concise with no wasted words, conveying all key information efficiently.

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 description lists the return fields, which is helpful, but it omits explanation of the timeout_ms parameter and leaves 'bounded' vague. With no output schema and an additional undocumented parameter, the description is adequate but not fully complete for an agent to invoke correctly without guessing.

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?

The schema describes 'name' but not 'timeout_ms', leaving 50% of parameter coverage. The tool description does not mention 'timeout_ms' at all, failing to explain its purpose or relationship to the 'bounded' diagnostics. Since schema coverage is only 50%, the description should compensate but does not.

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 the tool's action ('Check') on a specific resource ('latest registered GitLab pipeline') and enumerates the specific returned diagnostics (failed job, stage, ref, commit, URL, bounded trace diagnostics). This distinguishes it from sibling tools like list_gitlab_pipelines and unregister_gitlab_pipeline.

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 context for using this tool is clear: to retrieve failure details of the latest registered GitLab pipeline. It does not explicitly name alternatives or exclusions, but the sibling tools' names indicate different purposes (listing, unregistering), so an agent can infer when to use this one.

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