pipeline_cancel_run

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

Annotations already declare destructiveHint=true, and the description's 'Cancel' is consistent with that, so there is no contradiction. The description adds no further behavioral context such as irreversibility, idempotency, or effects on downstream steps, but the annotation covers the core destructive nature.

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 a single, front-loaded sentence with no filler words. Every word contributes the core action and target, so it is appropriately concise.

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 three-parameter cancellation tool, the schema fully documents the inputs and annotations establish the destructive behavior. The description states what it does, which is enough for most invocation scenarios, though it omits details like handling of already-completed runs or whether cancellation is asynchronous.

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?

Input schema coverage is 100%, with each parameter described (e.g., 'The job instance ID to cancel'). The description itself adds no parameter-level meaning, so the baseline of 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?

The description clearly states the specific verb 'Cancel' applied to a 'running pipeline execution', which is distinct from pipeline_run, pipeline_get_run_status, and pipeline_delete in the sibling list. The resource and action are 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?

The intended use is implied: cancel a running pipeline execution. However, the description gives no explicit guidance about alternatives (e.g., pipeline_delete for removing a pipeline definition, pipeline_get_run_status for checking status) or preconditions, leaving some inference required.

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