Skip to main content
Glama

migration_listHistoricBatches

Query historic MIGRATE_PROCESS_INSTANCE migration batches from the Operaton history log, filtering by completion status and start date range to audit past migrations.

Instructions

Query historic migration batches from the Operaton history log. Filters: completion status, date range. Always scoped to MIGRATE_PROCESS_INSTANCE batch type.

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

Input Schema

NameRequiredDescriptionDefault
completedNoFilter by completion status
maxResultsNoMaximum number of results (default: 50)
startedAfterNoFilter batches started after this date-time (ISO 8601)
startedBeforeNoFilter batches started before this date-time (ISO 8601)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.3.0
    • addedInput schema / properties / completed
      Added value: +{
      +  "description": "Filter by completion status",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / maxResults
      Added value: +{
      +  "description": "Maximum number of results (default: 50)",
      +  "type": "number"
      +}
    • addedInput schema / properties / startedAfter
      Added value: +{
      +  "description": "Filter batches started after this date-time (ISO 8601)",
      +  "type": "string"
      +}
    • addedInput schema / properties / startedBefore
      Added value: +{
      +  "description": "Filter batches started before this date-time (ISO 8601)",
      +  "type": "string"
      +}
  2. First observedv1.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description must carry the behavioral load. It does disclose a real constraint that structured fields do not: results are always scoped to MIGRATE_PROCESS_INSTANCE batch type, which is valuable. However, it says nothing about ordering, how all-optional filters behave when omitted (full scan of history?), or the shape/cost of the response.

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?

Three short sentences, front-loaded with the verb and resource, with the hard scoping constraint placed last for emphasis. The "Filters:" clause is mildly redundant with the schema but is short enough to earn its place as a scan cue.

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 read-only query tool with four optional parameters this covers purpose and scope, but there is no output schema and the description gives no indication of what a batch record contains or how results are ordered/paged. That leaves an agent unable to anticipate the return value without calling it.

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 all four parameters are already documented with types and ISO 8601 format notes. The description's "Filters: completion status, date range" restates the schema rather than adding syntax, defaults, or interaction rules, so baseline 3 applies.

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 ("Query historic migration batches") and names the data source (the Operaton history log), which implicitly separates it from the live-batch sibling migration_listBatches. It never names that sibling explicitly, so the differentiation relies on the reader inferring the historic-vs-current split.

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 implied by the word "historic" and the history-log source, so an agent can infer this is the archival view. There is no explicit statement of when to prefer this over migration_listBatches or migration_getBatchStatus, and no exclusions or prerequisites are given.

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