Skip to main content
Glama

processDefinition_getMigrationCandidates

Compare source and target process definition activities to identify auto-mappable pairs, unmapped source activities, and new target activities; optionally check required variables on instance IDs.

Instructions

Compare source and target process definition activities. Returns auto-mappable pairs, unmapped source activities, new target activities. Optionally checks required variable presence on supplied instance IDs.

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": "processDefinition_getMigrationCandidates"
  }
}

Input Schema

NameRequiredDescriptionDefault
instanceIdsNoInstance IDs to check for required variable presence (sampled check)
requiredVariablesNoVariable names that must be present on migrating instances
sourceProcessDefinitionIdYesID of the source process definition
targetProcessDefinitionIdYesID of the target process definition

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.3.0
    • addedInput schema / properties / instanceIds
      Added value: +{
      +  "description": "Instance IDs to check for required variable presence (sampled check)",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / requiredVariables
      Added value: +{
      +  "description": "Variable names that must be present on migrating instances",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • 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 / required
      Added value: +[
      +  "sourceProcessDefinitionId",
      +  "targetProcessDefinitionId"
      +]
  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?

With no annotations, the description carries the full burden of behavioral disclosure. It usefully states the returned categories (auto-mappable pairs, unmapped source activities, new target activities) and notes an optional sampled variable-presence check. However, it never explicitly confirms the operation is read-only or describes side effects, permissions, or rate limits, leaving some behavioral gaps.

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?

The description is three tight sentences with no wasted wording. It is front-loaded with the primary comparison action, followed by return categories and the optional variable check. Every sentence contributes useful information.

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 four-parameter comparison tool with no output schema, the description does a good job explaining the main output categories and the optional variable check. It is nearly complete, though it could explicitly state that the operation is read-only and clarify how the return values are shaped.

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 the schema already documents all four parameters. The description adds only mild emphasis that the instance-ID check is optional and relates to required variable presence, but it does not explain sourceProcessDefinitionId or targetProcessDefinitionId beyond what the schema already provides. Baseline 3 is appropriate.

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?

The description uses a specific verb and resource: 'Compare source and target process definition activities.' It also lists the return categories, making the tool's purpose clear. However, it does not explicitly differentiate itself from sibling migration tools such as migration_generatePlan, so sibling differentiation is missing.

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?

The description gives no explicit guidance on when to use this tool versus alternatives like migration_generatePlan or migration_executeBatch. It implies the tool is for comparing process definitions and optionally checking variable presence, but does not state when that comparison should be performed or what prerequisites exist.

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