getPipelineRun

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. It does not state whether the operation is read-only, whether any side effects occur, or any authentication or rate-limit requirements. For a simple getter this is a notable omission, especially without annotations to cover safety.

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?

A single, efficient sentence that front-loads the action and resource. No filler or redundant wording; it earns its place.

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 is relatively simple, but with no output schema, no annotations, and incomplete parameter descriptions, the description leaves many gaps. It does not mention return format, optional vs required parameters, or any usage context. An agent would need to inspect the schema and infer behavior from the name alone.

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 only 33% (pipeline_uuid has a description; repo_slug and workspace do not). The tool description does not compensate by explaining what repo_slug and workspace are for, nor does it clarify that only pipeline_uuid is required. The description adds no parameter-level 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 clearly states the verb 'Get' and the resource 'details of a specific pipeline run', and lists the key fields (state, duration, result). This distinguishes it from siblings like listPipelineRuns (which lists runs) and getPipelineSteps (which gets steps). No ambiguity.

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 this tool is for fetching a single run, but it does not explicitly state when to use it over listPipelineRuns or mention alternatives. No exclusions or when-not-to-use guidance is provided, so it relies on inference from the name and context.

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