Skip to main content
Glama

migration_awaitBatch

Polls migration batches until all complete or timeout, returning COMPLETED or TIMEOUT with aggregated completed, failed, and pending job counts.

Instructions

Poll migration batch(es) until all complete or timeout is reached. Returns COMPLETED or TIMEOUT with aggregated progress (completed, failed, pending job counts).

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>",
      "timeoutSeconds": "<timeoutSeconds>"
    },
    "name": "migration_awaitBatch"
  }
}

Input Schema

NameRequiredDescriptionDefault
batchIdsYesBatch IDs to monitor
timeoutSecondsYesMaximum seconds to wait
pollIntervalSecondsNoPolling interval in seconds (default: 5)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.3.0
    • addedInput schema / properties / batchIds
      Added value: +{
      +  "description": "Batch IDs to monitor",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / pollIntervalSeconds
      Added value: +{
      +  "description": "Polling interval in seconds (default: 5)",
      +  "type": "number"
      +}
    • addedInput schema / properties / timeoutSeconds
      Added value: +{
      +  "description": "Maximum seconds to wait",
      +  "type": "number"
      +}
    • addedInput schema / required
      Added value: +[
      +  "batchIds",
      +  "timeoutSeconds"
      +]
  2. First observedv1.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations provided, the description carries the behavioral burden and does disclose that the tool polls until completion or timeout and returns COMPLETED or TIMEOUT with aggregate counts. It still omits important behavior such as whether jobs continue after timeout, error handling, and permission requirements.

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?

The definition is two tightly written sentences with no filler. The core behavior and return values are front-loaded and immediately usable.

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 moderately simple polling tool with three well-described parameters and no output schema, the description covers the essential outcome states and aggregated progress. It stops short of fully explaining timeout aftermath and failure behavior.

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%, so the schema already documents batchIds, timeoutSeconds, and pollIntervalSeconds. The description adds only the notion of one or more batches and aggregated progress, without further parameter-specific meaning 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?

The description states a specific verb and resource: polling migration batches until completion or timeout. It clearly describes a blocking wait operation, but it does not explicitly distinguish itself from point-in-time siblings such as migration_getBatchStatus or migration_getBatchSummary.

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 description implies when this tool is appropriate: when you need to wait for batch completion rather than check once. However, it gives no explicit guidance on when to use it instead of migration_getBatchStatus, migration_getBatchSummary, or migration_listBatches.

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