cancel_batch

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

Without annotations, the description must disclose effects but only says 'Cancel'. It does not mention irreversibility, cleanup actions, or impact on dependent jobs. The 'waitForCleanup' parameter hints at behavior but is not explained in the description.

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, concise sentence that front-loads the action. While effective, it could be slightly more structured by noting required parameters or conditions.

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 cancellation tool, the description is minimally adequate but lacks usage guidance and behavioral details that would help an agent decide when to invoke it. It does not explain return values or post-conditions, relying solely on the schema.

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 input schema already fully documents all 3 parameters with clear descriptions. The tool description adds no additional context beyond what the schema provides, so a baseline of 3 is appropriate.

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 verb 'Cancel' and the resource 'iSuite batch job', and distinguishes it from siblings like 'cancel_job' which likely targets individual jobs. The purpose is specific 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?

No guidance is provided on when to use this tool versus alternatives such as 'cancel_job' or 'rerun_batch'. The description omits context like state requirements (e.g., only running or pending) or scenarios where cancellation is inappropriate.

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