Skip to main content
Glama

migration_getBatchFailures

Retrieve per-instance failure details for one or more migration batches, including process instance, job, failure type, error message, and stacktrace.

Instructions

Retrieve per-instance failure details for one or more migration batches. Returns processInstanceId, jobId, failureType (EXHAUSTED_RETRIES), errorMessage, and stacktrace.

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_getBatchFailures"
  }
}

Input Schema

NameRequiredDescriptionDefault
batchIdsYesBatch IDs to retrieve failure details for

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 retrieve failure details for",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / required
      Added value: +[
      +  "batchIds"
      +]
  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, the description carries the full burden. It does useful work by enumerating the returned fields and pinning failureType to EXHAUSTED_RETRIES, which signals this is a read-only diagnostic tool. It omits what happens when a batch has no failures (empty result vs error) and whether the batch must be in a terminal state.

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 sentences, zero filler: the purpose is front-loaded and the second sentence delivers the return contract. Every clause earns its place.

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 one-parameter read tool with no output schema, describing the returned fields is the right compensation and it is done well. The only gap is edge-case behavior — no-failure batches and invalid or unknown batch IDs.

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% for the single batchIds parameter, so the schema already documents it. The phrase 'one or more migration batches' reinforces that the array accepts multiple IDs, but adds no format or limit 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?

The description opens with a specific verb and resource: 'Retrieve per-instance failure details for one or more migration batches.' The 'failure details' qualifier distinguishes it in substance from status/summary siblings, though it never names an alternative 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 by the purpose statement — an agent can infer this is the tool for inspecting why a batch failed. There is no explicit when-to-use, no prerequisite (e.g. batch must have completed), and no routing to migration_getBatchStatus or migration_retryFailedJobs.

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