Skip to main content
Glama

migration_getBatchStatus

Retrieve the current status of a single migration batch, including total, created, completed, failed, and suspended jobs, to monitor progress and detect issues.

Instructions

Get current status of a single migration batch: totalJobs, jobsCreated, jobsCompleted, jobsFailed, suspended.

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": {
      "batchId": "<batchId>"
    },
    "name": "migration_getBatchStatus"
  }
}

Input Schema

NameRequiredDescriptionDefault
batchIdYesBatch ID to retrieve status for

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • addedInput schema / properties / batchId
      Added value: +{
      +  "description": "Batch ID to retrieve status for",
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "batchId"
      +]
  2. First observedv1.1.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden; it does usefully disclose the return payload fields, which matters because there is no output schema. However, it never states that the call is a non-mutating read, what permissions are needed, or what happens when the batchId does not exist.

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?

A single, front-loaded sentence with no filler; the colon-separated field list is dense but communicates the return shape efficiently. Nothing in it is wasted, though it is terse enough that guidance content is absent entirely.

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

Completeness4/5

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

For a simple one-parameter read tool with no output schema, the response-field enumeration makes the definition largely sufficient. The remaining gap is edge-case behavior for an unknown or expired batchId, which is minor for this tool's complexity.

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% for the single batchId parameter, so the schema already documents it fully ('Batch ID to retrieve status for'). The description says 'single' batch, confirming one ID per call, but adds no format or sourcing detail beyond the schema.

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?

Uses a specific verb and resource ('Get current status of a single migration batch') and enumerates the fields returned (totalJobs, jobsCreated, jobsCompleted, jobsFailed, suspended). It does not explicitly distinguish itself from the sibling migration_getBatchSummary, so an agent must infer the difference between 'status' and 'summary'.

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?

There is no when-to-use guidance, no exclusions, and no mention of siblings such as migration_awaitBatch or migration_getBatchSummary. The phrase 'current status' only implicitly suggests polling, leaving the agent to infer its role in the migration workflow.

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