Cancel batch collection

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

The description states the tool 'persist[s] cancellation' and stops models from running — an environment-mutating action — while annotations declare readOnlyHint=true. This is a direct contradiction. The one useful nugget ('prevent unstarted models from running', implying in-flight models continue) is outweighed by the conflict.

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 short sentence with no filler, front-loaded with the core action. It is efficient, though the terse phrasing contributes to the ambiguity noted elsewhere.

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 need not be described, but for a cancellation tool the description omits what happens to already-running models, whether repeated calls are safe (annotation says idempotentHint=false), and any permission requirements. Combined with the readOnly contradiction, the definition is not complete enough to call safely.

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% and the description says nothing about run_id — not its format, nor where to obtain it (presumably from revit_batch_start). With a low-coverage schema the description is expected to compensate, and it does not.

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 name and title ('Cancel batch collection') identify the resource and the description adds the scope ('persist cancellation and prevent unstarted models from running'). However, the phrasing is indirect — it never plainly says 'cancels a batch run' — and it does not distinguish itself from siblings like revit_batch_start, revit_batch_status, or revit_batch_fetch.

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?

There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as checking revit_batch_status before cancelling or using revit_batch_fetch to inspect results. The agent must infer the trigger condition entirely.

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