Skip to main content
Glama
Model MCP

Model MCP

Cancel batch collection

revit_batch_cancel

Cancel a batch run by run ID to stop unstarted models from running and persist the cancellation.

Instructions

Persist cancellation and prevent unstarted models from running.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "run_id": "<run_id>"
    },
    "name": "revit_batch_cancel"
  }
}

Input Schema

NameRequiredDescriptionDefault
run_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.10.0
    • removedInput schema / properties / run_id / title
      Removed value: -"Run Id"
    • removedInput schema / title
      Removed value: -"revit_batch_cancelArguments"
    • removedOutput schema / title
      Removed value: -"revit_batch_cancelDictOutput"
  2. Addedv0.7.0

TDQS

B3.2/5.0
Behavior3/5

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

Beyond the annotations' mutation and safety hints, the description adds that cancellation is persisted and that unstarted models will be prevented from running. It leaves important scope questions unresolved, including what happens to models already running and whether a completed or previously cancelled run can be cancelled again.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single sentence is compact, front-loaded, and contains no filler. However, the compressed phrase 'Persist cancellation' is less immediately intelligible than a direct statement about saving the batch's cancelled state.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The essential action and pending-model scope are present, and the output schema removes the need to document return values here. For reliable invocation, though, the definition still needs run_id provenance and clearer lifecycle and sibling-tool context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description needed to compensate for the sole run_id parameter but never mentions it. Its purpose as a batch-run identifier is inferable from the name, yet its source, expected format, and validity requirements remain undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Together with the title, the description clearly conveys cancelling a batch collection and specifically preventing its unstarted models from running. It does not explicitly differentiate this batch-level operation from the sibling revit_cancel_job.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The reference to unstarted models implies when cancellation is useful, but there is no explicit when-to-use guidance or prerequisite workflow. In particular, it does not direct agents to revit_batch_start for obtaining a run, revit_batch_status for inspection, or revit_cancel_job for a different cancellation scope.

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

Deploy Server

Other Tools