Skip to main content
Glama

migration_deleteBatch

Cancel one or more migration batches by ID, with optional cascade deletion of associated historic data, and return per-batch success or error.

Instructions

Cancel (delete) one or more migration batches by ID. Returns per-batch success or error.

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": {
      "batchIds": "<batchIds>"
    },
    "name": "migration_deleteBatch"
  }
}

Input Schema

NameRequiredDescriptionDefault
cascadeNoIf true, also delete historic data for this batch
batchIdsYesBatch IDs to delete (cancel)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.3.0
    • addedInput schema / properties / batchIds
      Added value: +{
      +  "description": "Batch IDs to delete (cancel)",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / cascade
      Added value: +{
      +  "description": "If true, also delete historic data for this batch",
      +  "type": "boolean"
      +}
    • addedInput schema / required
      Added value: +[
      +  "batchIds"
      +]
  2. First observedv1.1.0

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does add two useful facts — that deletion is framed as cancellation, and that results come back per batch with individual errors — but it says nothing about irreversibility, required permissions, what happens to in-flight batch execution, or how partial failures are handled. The destructive 'cascade' path is only described in the schema, not here.

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

Conciseness5/5

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

Two compact sentences with zero waste; the action and scope lead, and the return behavior follows. Nothing is redundant or buried.

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?

With no output schema, the 'per-batch success or error' line usefully sketches the response shape. However, for a destructive multi-item operation with no annotations, the definition should at minimum warn about irreversibility and the cascade option's effect on historic data; those gaps keep it at merely adequate.

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

Parameters3/5

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

Schema description coverage is 100%, so both batchIds and cascade are already documented in the schema, including the historic-data meaning of cascade. The description reinforces that IDs identify batches to cancel but adds no format, limit, or semantics beyond what the schema states; baseline 3 applies.

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?

States a specific verb and resource ('Cancel (delete) one or more migration batches') plus the addressing key ('by ID'), which clearly separates it from read-oriented siblings like migration_getBatchStatus or migration_listBatches. It does not explicitly contrast with migration_suspendBatch, which is the nearest ambiguous alternative, so it stops short of a 5.

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 parenthetical '(delete)' implies this is the terminal action versus suspending, and 'one or more' signals batch usage, but there is no explicit when-to-use/when-not statement or named alternative. The agent must infer that suspend/resume are the non-destructive counterparts.

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