Skip to main content
Glama

migration_suspendBatch

Suspend one or more migration batches by ID and return per-batch success or error results.

Instructions

Suspend 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_suspendBatch"
  }
}

Input Schema

NameRequiredDescriptionDefault
batchIdsYesBatch IDs to suspend

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • addedInput schema / properties / batchIds
      Added value: +{
      +  "description": "Batch IDs to suspend",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / required
      Added value: +[
      +  "batchIds"
      +]
  2. First observedv1.1.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It usefully discloses partial-failure behavior ('Returns per-batch success or error'), but says nothing about what suspension actually does to an in-flight batch, whether it is reversible, or whether any permissions are required.

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 short sentences with zero filler: the action comes first and the return behavior second. Nothing could be removed without losing information.

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 description covers the return shape well enough that a missing output schema is not a blocker for a single-parameter mutation. However, with no annotations to describe the mutation's effects or safety profile, the definition leaves the agent guessing about state changes and reversibility.

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 coverage is 100% with a single array parameter already described as 'Batch IDs to suspend'. The description repeats that meaning rather than adding constraints such as a maximum batch count or an error-handling contract for partial success.

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?

A specific verb and resource: 'Suspend one or more migration batches by ID.' The verb 'suspend' implicitly contrasts with the sibling 'resume'/'delete' operations, but the description never names those alternatives or states how the outcome differs.

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

Usage Guidelines2/5

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

No when-to-use guidance, no prerequisites, and no note on when to prefer suspend over resume/delete or execute. The agent must infer from the tool name alone that this pauses rather than cancels a batch.

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