Skip to main content
Glama

migration_generatePlan

Generate a migration plan from a source to a target process definition, listing auto-mapped activity instructions and unmapped source activities that require explicit mapping.

Instructions

Generate a migration plan from a source to target process definition. Returns auto-mapped activity instructions and a list of unmapped source activities requiring explicit mapping.

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": {
      "sourceProcessDefinitionId": "<sourceProcessDefinitionId>",
      "targetProcessDefinitionId": "<targetProcessDefinitionId>"
    },
    "name": "migration_generatePlan"
  }
}

Input Schema

NameRequiredDescriptionDefault
updateEventTriggersNoIf true, update event triggers in migrated instances (default: false)
sourceProcessDefinitionIdYesID of the source process definition
targetProcessDefinitionIdYesID of the target process definition

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.3.0
    • addedInput schema / properties / sourceProcessDefinitionId
      Added value: +{
      +  "description": "ID of the source process definition",
      +  "type": "string"
      +}
    • addedInput schema / properties / targetProcessDefinitionId
      Added value: +{
      +  "description": "ID of the target process definition",
      +  "type": "string"
      +}
    • addedInput schema / properties / updateEventTriggers
      Added value: +{
      +  "description": "If true, update event triggers in migrated instances (default: false)",
      +  "type": "boolean"
      +}
    • addedInput schema / required
      Added value: +[
      +  "sourceProcessDefinitionId",
      +  "targetProcessDefinitionId"
      +]
  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 provided, so the description carries the full behavioral burden. It discloses that output includes auto-mapped instructions and unmapped activities, which is useful, but it does not say whether the plan is persisted, whether it mutates any state, or what permissions/error behavior apply.

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 front-loaded sentences: purpose first, return contents second. There is no redundant or filler wording.

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?

This is a moderate-complexity migration tool with no annotations and no output schema. The description covers purpose and return content but omits workflow ordering and side-effect/persistence details needed for safe invocation.

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?

All three parameters are documented at 100% schema coverage. The description references source and target process definitions conceptually but adds no new detail about updateEventTriggers or ID semantics beyond what the schema already provides.

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?

Names a specific verb (Generate) and resource (migration plan) and the endpoints (source to target process definition). It does not distinguish itself from the sibling migration_validatePlan, but the core purpose is unambiguous.

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?

The description implies this is the planning step in a migration workflow, but never states when to call it relative to migration_validatePlan or migration_executeBatch, nor any prerequisites or exclusions. Guidance is only inferable from the verb.

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