restart_pipeline

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

No annotations are provided, so the description carries the burden. It discloses the key behavior (re-runs all jobs from the beginning) and the required state (completed or failed), but does not mention side effects, deletion of old runs, permissions, or how to monitor the restarted pipeline.

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?

Two concise sentences with no filler. The first sentence states the action and target, the second clarifies the execution behavior and identification method. Every word 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?

For a simple restart tool with 3 documented parameters and no output schema, the description is nearly complete. It explains what happens, when it can be used, and how to identify the pipeline. Minor gaps include response behavior or progress tracking, but these are not critical for selection and invocation.

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 already covers 100% of parameters, and the description adds extra context for pipeline_id by explaining it is the 'local numeric ID from list_pipelines', which clarifies how to obtain and use it beyond the schema's 'Pipeline local ID'.

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 uses a specific verb 'Restart' with a clear resource ('CI/CD pipeline'), and elaborates with 'Re-runs all jobs from the beginning', which distinguishes it from sibling tools like restart_job and start_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?

It clearly states when to use the tool: for a 'previously completed or failed' pipeline. This implies it is not for running pipelines, and the phrase 'from the beginning' contrasts with restart_job, though no explicit alternatives are named.

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