openvsp.batch_cancel

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

No annotations are provided, so the description carries the full behavioral burden. It usefully discloses the whole-batch-when-empty conditional, but it does not state whether cancellation is irreversible, what happens to running jobs, or any permission requirements.

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?

A single, front-loaded sentence with an active verb and no filler. Every word contributes meaning, and the important edge case is included without extra noise.

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 low-complexity and an output schema exists, so return-value documentation is not needed. However, with no annotations, the lack of cancellation semantics (reversibility, effects, prerequisites) leaves the definition only minimally complete for safe invocation.

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%, so the description must compensate. It does map 'selected case IDs' to case_ids and the empty case to whole-batch cancellation, but it never mentions the required batch_directory parameter or the maxItems constraint.

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 uses a specific verb ('Cancel') with a clear scope: selected case IDs or the entire batch when the ID list is empty. This distinguishes it sharply from sibling tools like batch_submit, batch_status, and batch_resume.

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?

Usage is implied rather than explicit: the description makes it clear this is the cancellation operation, but it does not say when to prefer it over alternatives or when cancellation is inappropriate (e.g., already-completed batches).

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