restart_job

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

With no annotations, the description carries the burden of disclosing side effects. It adds context that the restart does not re-run the entire pipeline, but it does not explain what happens to the job's state, artifacts, or whether the job must be in a specific state (e.g., failed) to restart.

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, front-loaded with the primary action and followed by a clear use case. No redundancy or filler.

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 simple with fully documented parameters. The description covers the key distinction from full pipeline restarts and the retry use case. However, it omits any prerequisites or post-conditions (e.g., job must be failed, or that a new job run is triggered), which would improve completeness.

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 coverage is 100%, so the schema already fully documents all parameters. The description adds minimal parameter semantics beyond referring to a 'specific CI/CD job', which aligns with job_id but does not enrich understanding.

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 restarts a specific CI/CD job, distinguishing it from restarting the entire pipeline. The verb 'restart' and resource 'specific CI/CD job' are precise and unambiguous.

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?

Provides clear use case: retrying a single failed job while keeping other completed jobs intact. This implies when to use it and hints at not using it for full pipeline restarts, though it does not explicitly name alternatives like restart_pipeline.

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