Skip to main content
Glama

migration_validatePlan

Validate a migration plan against selected process instances, returning typed errors, a sampled-validation flag, and disclosed consequences like timers, external tasks, and cancellations.

Instructions

Validate a migration plan against a set of process instances. Returns typed errors, sampled-validation flag, and consequence disclosure (timers, external tasks, cancellations).

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

Input Schema

NameRequiredDescriptionDefault
planYesMigration plan with instructions
instanceIdsYesProcess instance IDs to validate the plan against
instructionsNoOptional migration execution instructions (for consequence disclosure)
totalInstanceCountNoTotal active instance count for this definition — used to detect sampled validation

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.3.0
    • addedInput schema / properties / instanceIds
      Added value: +{
      +  "description": "Process instance IDs to validate the plan against",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / instructions
      Added value: +{
      +  "description": "Optional migration execution instructions (for consequence disclosure)",
      +  "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 / properties / totalInstanceCount
      Added value: +{
      +  "description": "Total active instance count for this definition — used to detect sampled validation",
      +  "type": "number"
      +}
    • addedInput schema / required
      Added value: +[
      +  "plan",
      +  "instanceIds"
      +]
  2. First observedv1.1.0

TDQS

A3.6/5.0
Behavior4/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 useful behavior: it returns typed errors, a sampled-validation flag, and consequence disclosures covering timers, external tasks, and cancellations. It does not state that the call is non-mutating (only implied by "validate") or describe error shapes or permission requirements.

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 tight sentences with the action first and the return contract second. Every clause carries information; nothing is repeated from the schema or padding.

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?

There is no output schema, so summarizing the return content (typed errors, sampled flag, consequence disclosure) is exactly the right compensation, and it does so. Completeness would be higher with a note that validation is read-only and typically precedes migration_executeBatch.

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 plan, instanceIds, instructions, and totalInstanceCount are already documented, including the sampled-validation purpose of totalInstanceCount. The description adds no additional parameter-level meaning, so the baseline of 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 ("Validate a migration plan") plus the input it validates against (a set of process instances). It is clearly distinct from migration_generatePlan and migration_executeBatch by name and phrasing, though it never explicitly contrasts itself with those siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use guidance, no mention of prerequisites (e.g. that a plan usually comes from migration_generatePlan first), and no statement about when to skip validation. Usage as a pre-execution check is only implied by the word "validate".

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