cancel_patch_job

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

No annotations provided. The term 'cooperative cancellation' hints at non-forceful termination but lacks details on side effects, idempotency, or what happens if already completed.

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?

Extremely concise (one phrase) but at the cost of completeness; boundary of appropriate conciseness.

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?

Given no output schema, one param, and related siblings, the description is insufficient. Lacks mention of expected behavior (e.g., job may not stop immediately), potential failures, or post-cancellation status checks.

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 has one parameter 'job_id' with no description; description coverage is 0%. The description does not explain how to obtain job_id or its format.

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 states the verb 'cancel' and the resource 'background streamed job', which is clear and specific. However, it doesn't differentiate from sibling tools like 'get_patch_job' or 'submit_patch_job'.

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?

No guidance on when to use this tool versus alternatives; missing context like 'use this to stop a running job when it is no longer needed'.

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