pipeline_timeline

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

With no annotations, the description carries the full behavioral burden. 'Retrieve' implies a read, and the filtering note hints at payload size, but nothing is said about permissions, pagination, response shape, or whether it is safe/non-mutating. For a 6-parameter tool this is thin.

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 front-loaded sentence that states the action first. The trailing clause about reducing data is slightly awkwardly joined with a comma splice, but overall it is compact with little waste.

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?

For a read-only retrieval tool with fully documented parameters and no output schema, the description covers the core purpose and the main filter rationale. It leaves out the routing guidance against sibling pipeline tools and any behavioral detail, so it is adequate rather than complete.

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 schema already documents runId, state, result, projectId, pipelineId, and timelineId. The description restates the state/result filters but adds no format or defaulting detail beyond the schema, so the baseline 3 applies.

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?

States a specific verb ('Retrieve') and resource ('timeline of stages and jobs for a pipeline run'), which is distinct from siblings like get_pipeline_run or list_pipeline_runs. However it does not explicitly contrast itself with those siblings, so an agent must infer the distinction.

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 only usage hint is that filtering by state and result reduces returned data. There is no guidance on when to prefer this over get_pipeline_run, list_pipeline_runs, or get_pipeline_log, and no prerequisites such as needing a runId from a prior call.

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