Skip to main content
Glama

migration_listBatches

List active process-instance migration batches, optionally filtered by suspended state, to monitor ongoing migrations and check batch status.

Instructions

List active migration batches (type MIGRATE_PROCESS_INSTANCE). Optionally filter by suspended state.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "migration_listBatches"
  }
}

Input Schema

NameRequiredDescriptionDefault
suspendedNoFilter by suspended state
maxResultsNoMaximum number of results (default: 50)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • addedInput schema / properties / maxResults
      Added value: +{
      +  "description": "Maximum number of results (default: 50)",
      +  "type": "number"
      +}
    • addedInput schema / properties / suspended
      Added value: +{
      +  "description": "Filter by suspended state",
      +  "type": "boolean"
      +}
  2. First observedv1.1.0

TDQS

A3.5/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 the type restriction to MIGRATE_PROCESS_INSTANCE and the active-only scope, but says nothing about ordering, pagination behavior beyond maxResults, or whether non-migration batch types are silently excluded.

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 the scope constraint front-loaded and zero filler. Every clause carries information the agent needs to select and call the tool.

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?

For a two-parameter read-only listing tool with no output schema, the definition covers the essentials. It still leaves open what a returned batch contains and how results are bounded or ordered, which matters for an agent deciding whether one call is enough.

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 parameters are already documented and the baseline is 3. The description restates the suspended filter but adds no semantics for maxResults, such as whether a truncated result set is indicated or how to page further.

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 (List) and resource (migration batches) and narrows scope to active batches of type MIGRATE_PROCESS_INSTANCE. The word 'active' implicitly separates it from migration_listHistoricBatches, though no sibling is named explicitly.

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?

Usage is only implied: 'active' suggests this is the tool for in-flight batches rather than completed ones, and 'optionally filter' signals the filter is not required. There is no explicit statement of when to prefer this over migration_listHistoricBatches or migration_getBatchStatus.

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