pipeline_init

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

Discloses key behaviors: requires confirm=True, overwrites existing file, internal flag _bypass_active_check. No annotations provided, so description carries full burden and does well.

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?

Concise, with first sentence stating purpose followed by bullet-like points. No wasted words, 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?

Covers behavioral aspects, usage context, and internal flag. Output schema exists for return values. Missing parameter explanations slightly reduce 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 description coverage is 0%, requiring description to explain parameters. Only confirm and _bypass_active_check are explained; type, feature, project are not described despite being unclear.

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?

Description clearly states 'Initialise a new pipeline state file from the template', a specific verb+resource. It distinguishes from siblings like pipeline_reset by noting it's for starting a brand-new 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?

Explicitly states when to use ('starting a brand-new feature or hotfix pipeline') and warns about accidental invocation. Does not explicitly list when not to use, but context is clear.

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