Skip to main content
Glama

migration_getBatchSummary

Aggregate post-migration results across one or more batch IDs to report total submitted, succeeded, failed, and duration for deployment sign-off.

Instructions

Aggregate post-migration summary across one or more batch IDs: totalSubmitted, succeeded, failed, duration. Suitable for deployment sign-off records.

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

Input Schema

NameRequiredDescriptionDefault
batchIdsYesBatch IDs to aggregate summary 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 aggregate summary 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?

No annotations are supplied, so the description carries the full behavioral burden. It discloses what is returned (the four aggregate metrics), which is valuable, but says nothing about error behavior for unknown or incomplete batch IDs, whether in-flight batches are included, or whether results are pre-aggregated versus computed on read.

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, front-loaded with the action and resource, followed by the returned metrics and the intended use. Nothing is padded or repeated from the schema.

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 single-parameter read tool with no output schema, listing the aggregate fields in the description is exactly the right compensation. Only the edge-case behavior for unknown or partially complete batches is left unstated.

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 batchIds array parameter, so the baseline is 3. The description reinforces that the array may hold one or more IDs (multi-batch aggregation), but adds no format, limit, or ordering semantics 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?

States a specific verb and resource — 'Aggregate post-migration summary' — and enumerates the aggregate fields returned (totalSubmitted, succeeded, failed, duration). The word 'Aggregate ... across one or more batch IDs' implicitly separates it from per-batch siblings like migration_getBatchStatus, but 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?

'Suitable for deployment sign-off records' gives a concrete usage scenario, which is more than nothing. However, it gives no when-not guidance (e.g., use getBatchStatus for a single batch's progress) and no prerequisites for the batch IDs.

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