Skip to main content
Glama

processInstance_listMigratable

Lists active process instances eligible for migration by process definition key, showing per-instance eligibility and call-activity blockers; filter by source version or business key pattern.

Instructions

List active process instances eligible for migration. Returns per-instance eligibility with call-activity blocking conditions. Filters: definition key, source version, business key pattern.

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": {
      "processDefinitionKey": "<processDefinitionKey>"
    },
    "name": "processInstance_listMigratable"
  }
}

Input Schema

NameRequiredDescriptionDefault
maxResultsNoMaximum number of instances to return (default: 100)
sourceVersionNoRestrict to instances of this definition version
businessKeyLikeNoFilter by business key pattern (SQL LIKE syntax, % wildcard)
processDefinitionKeyYesProcess definition key to list migratable instances for

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.3.0
    • addedInput schema / properties / businessKeyLike
      Added value: +{
      +  "description": "Filter by business key pattern (SQL LIKE syntax, % wildcard)",
      +  "type": "string"
      +}
    • addedInput schema / properties / maxResults
      Added value: +{
      +  "description": "Maximum number of instances to return (default: 100)",
      +  "type": "number"
      +}
    • addedInput schema / properties / processDefinitionKey
      Added value: +{
      +  "description": "Process definition key to list migratable instances for",
      +  "type": "string"
      +}
    • addedInput schema / properties / sourceVersion
      Added value: +{
      +  "description": "Restrict to instances of this definition version",
      +  "type": "number"
      +}
    • addedInput schema / required
      Added value: +[
      +  "processDefinitionKey"
      +]
  2. First observedv1.1.0

TDQS

A3.6/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. It does add real behavioral value by noting the response carries per-instance eligibility and call-activity blocking conditions, which tells the agent some instances will be reported as ineligible. However, it says nothing about read-only safety, permission requirements, pagination/truncation behavior, or ordering.

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?

Three short, front-loaded sentences: purpose first, then return semantics, then the filter summary. No filler and nothing that could be cut without losing 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 read tool with no output schema and no annotations, the description covers purpose, response shape (eligibility plus blocking conditions), and filter scope. Only the safety/permission profile and pagination defaults are left implicit.

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 including the required definition key and the LIKE syntax for businessKeyLike. The description only restates the filter list, adding no syntax or edge-case meaning 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 and resource ('List active process instances') plus a clear qualifier ('eligible for migration'), which separates it from the plain processInstance_list sibling. It never names that sibling as the alternative, so differentiation is implied rather than stated outright.

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 phrase 'eligible for migration' implies the context in which to call it, but there is no explicit when-to-use versus processInstance_list / migration_listBatches guidance and no stated prerequisites, such as needing a target migration plan first.

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