Cancel batch collection

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

The annotations declare readOnlyHint=true, but the description claims side effects: 'Persist cancellation and prevent unstarted models from running' is a state-changing, queue-altering operation, not a read. This directly contradicts the readOnlyHint, and no additional behavioral context (partial cancel semantics, already-finished runs, idempotency) is offered.

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 compact sentence with the key effect front-loaded and no filler. It is appropriately sized, though it omits detail that a one-parameter mutation tool would benefit from.

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?

An output schema exists so return values needn't be explained, but for a cancellation operation the description leaves out relevant behavior: what happens if the run already completed, whether cancellation is gradual, and what identifies the run. Combined with the annotation conflict, the definition is not complete enough.

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% for the single required run_id, and the description never mentions it or its expected format. The parameter name is reasonably self-explanatory, but the description does nothing to compensate for the coverage gap.

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 a specific action (cancel a batch) and its consequences: 'Persist cancellation and prevent unstarted models from running.' An agent can tell this controls an in-flight batch job rather than a document. It does not, however, distinguish itself from the sibling revit_cancel_job or explicitly name the batch run it operates on.

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 when-to-use guidance is given. With siblings like revit_cancel_job, revit_batch_status, revit_batch_start, and revit_batch_fetch, the description never says when this tool is the right choice versus those alternatives, nor any precondition (e.g., run must be active).

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