Skip to main content
Glama

migration_executeBatch

Executes a migration plan asynchronously, auto-chunking large instance lists and returning batch IDs or submission errors; use dryRun to validate without creating batches.

Instructions

Execute a migration plan asynchronously. Auto-chunks large instance lists. Returns batch IDs and chunk submission errors. Supports dryRun mode (validates without creating batches).

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": {
      "plan": "<plan>",
      "instanceIds": "<instanceIds>"
    },
    "name": "migration_executeBatch"
  }
}

Input Schema

NameRequiredDescriptionDefault
planYesMigration plan with instructions
dryRunNoIf true, validates the plan without creating batches
batchSizeNoMax instances per Operaton batch (default: 100)
instanceIdsYesProcess instance IDs to migrate
instructionsNoOptional execution instructions (cancelActivities, variableUpdates)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.3.0
    • addedInput schema / properties / batchSize
      Added value: +{
      +  "description": "Max instances per Operaton batch (default: 100)",
      +  "type": "number"
      +}
    • addedInput schema / properties / dryRun
      Added value: +{
      +  "description": "If true, validates the plan without creating batches",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / instanceIds
      Added value: +{
      +  "description": "Process instance IDs to migrate",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / instructions
      Added value: +{
      +  "description": "Optional execution instructions (cancelActivities, variableUpdates)",
      +  "items": {
      +    "properties": {
      +      "cancelActivities": {
      +        "type": "boolean"
      +      },
      +      "sourceActivityIds": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "targetActivityIds": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "updateEventTrigger": {
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "sourceActivityIds",
      +      "targetActivityIds"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / plan
      Added value: +{
      +  "description": "Migration plan with instructions",
      +  "properties": {
      +    "instructions": {
      +      "items": {
      +        "properties": {
      +          "sourceActivityIds": {
      +            "description": "Source activity IDs",
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "targetActivityIds": {
      +            "description": "Target activity IDs",
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "updateEventTrigger": {
      +            "type": "boolean"
      +          }
      +        },
      +        "required": [
      +          "sourceActivityIds",
      +          "targetActivityIds"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "sourceProcessDefinitionId": {
      +      "type": "string"
      +    },
      +    "targetProcessDefinitionId": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "sourceProcessDefinitionId",
      +    "targetProcessDefinitionId",
      +    "instructions"
      +  ],
      +  "type": "object"
      +}
    • addedInput schema / required
      Added value: +[
      +  "plan",
      +  "instanceIds"
      +]
  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?

With no annotations, the description carries the full burden and does disclose real traits: asynchronous execution, automatic chunking of large instance lists, returned batch IDs, and chunk submission errors. It omits partial-failure semantics (what happens when some chunks fail), required permissions, and idempotency, which matter for a write operation.

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?

Four short sentences, each carrying distinct information (async mode, chunking, return shape, dryRun) with the core behavior front-loaded and no filler.

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 5-parameter mutation tool with nested objects and no output schema, the description covers execution model, chunking and partial return data, but leaves out failure handling, ordering guarantees, and the natural next step (awaiting the batch), so it is adequate rather than complete.

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 plan, instanceIds, dryRun, batchSize and instructions. The description reinforces dryRun and ties auto-chunking to the batch-size concept but adds no syntax or constraint 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?

States a specific verb (Execute) and resource (a migration plan), plus that it runs asynchronously. It does not name the sibling it supersedes (migration_validatePlan or migration_generatePlan), but the execute-vs-plan distinction is inferable from the verb.

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: the dryRun note hints that this tool can validate instead of a separate validate call, but there is no explicit when-to-use/when-not guidance and no pointer to migration_generatePlan or migration_awaitBatch for the async follow-up.

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