pipeline_steps

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

No annotations are provided, so the description carries the full burden. It only states the action ('Get') and lists parameters. It does not disclose whether the operation is read-only, any error conditions, rate limits, or what happens with missing optional params. The description is minimal and lacks behavioral context.

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 extremely concise: a one-line purpose statement followed by an Args list. Every word earns its place. It is front-loaded and easy to scan.

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 an output schema, so the description need not explain return values. However, it lacks guidance on when to use the tool and how workspace/repo relate to pipeline_uuid. For a simple read tool, it is adequate but not complete; it misses optional param details and any post-conditions.

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 0%, so the description's Args list adds value by explaining each parameter: pipeline_uuid, workspace slug, repo slug. It clarifies the semantic meaning (e.g., 'slug') beyond the schema titles. However, it does not mention that workspace and repo are optional or have defaults, which the schema shows.

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 'Get steps/stages of a pipeline run' with a specific verb and resource. It distinguishes from sibling tools like list_pipelines (which lists runs) and trigger_pipeline (which triggers runs).

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 usage: you need a pipeline_uuid to get its steps. It does not explicitly state when to use this vs alternatives, nor does it mention any prerequisites or exclusions. Usage context is inferred from the tool name and the args list.

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