Skip to main content
Glama

processInstance_list

List active process instances with optional filters such as business key, definition key or ID, state, variable values, and tenant. Returns instance ID, definition key, state, and business key.

Instructions

List active process instances with optional filters: business key, definition key/id, state, variable values, and tenant. Returns id, definitionKey, state, and business key.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "processInstance_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
activeNo
sortByNo
sortOrderNo
suspendedNo
variablesNo
incidentIdNo
maxResultsNo
tenantIdInNo
businessKeyNo
firstResultNo
activityIdInNo
deploymentIdNo
incidentTypeNo
withIncidentNo
caseInstanceIdNo
businessKeyLikeNo
incidentMessageNo
subCaseInstanceNo
withoutTenantIdNo
superCaseInstanceNo
processInstanceIdsNo
subProcessInstanceNo
incidentMessageLikeNo
processDefinitionIdNo
leafProcessInstancesNo
processDefinitionKeyNo
rootProcessInstancesNo
superProcessInstanceNo
rootProcessInstanceIdNo
processDefinitionKeyInNo
variableNamesIgnoreCaseNo
variableValuesIgnoreCaseNo
processDefinitionKeyNotInNo
processDefinitionWithoutTenantIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed34 schema fields changedv1.3.0
    • addedInput schema / properties / active
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / activityIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / businessKey
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / businessKeyLike
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / caseInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / deploymentId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / firstResult
      Added value: +{
      +  "type": "number"
      +}
    • addedInput schema / properties / incidentId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / incidentMessage
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / incidentMessageLike
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / incidentType
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / leafProcessInstances
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / maxResults
      Added value: +{
      +  "type": "number"
      +}
    • addedInput schema / properties / processDefinitionId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processDefinitionKey
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processDefinitionKeyIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processDefinitionKeyNotIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processDefinitionWithoutTenantId
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / processInstanceIds
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / rootProcessInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / rootProcessInstances
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / sortBy
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / sortOrder
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / subCaseInstance
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / subProcessInstance
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / superCaseInstance
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / superProcessInstance
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / suspended
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / tenantIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / variableNamesIgnoreCase
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / variableValuesIgnoreCase
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / variables
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / withIncident
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / withoutTenantId
      Added value: +{
      +  "type": "boolean"
      +}
  2. First observedv1.1.0

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are supplied, so the description carries the full behavioral burden, yet it says nothing about paging behavior, default sort order, result caps, or permissions. It also claims "active" instances while the schema exposes active/suspended booleans that imply non-active listings, leaving the default semantics ambiguous.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences, front-loaded with purpose then filters then return fields, with no filler. It is efficient but under-specified rather than padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 34-parameter tool with no annotations and no output schema, the definition is far too thin: paging, sorting, and roughly two dozen filters are unaddressed. An agent could not call this reliably without external API knowledge.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 34 parameters at 0% schema description coverage, the definition only glosses six filter families and omits pagination (maxResults/firstResult), sorting (sortBy/sortOrder), incident filters, and case-instance filters. Most parameters remain undocumented in both schema and description.

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") and enumerates the main filter families plus the returned fields. It doesn't explicitly differentiate from history_listProcessInstances or processInstance_count, so an agent must infer the boundary from the names.

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 when-to-use guidance, no statement of exclusions, and no pointer to alternatives such as processInstance_count for totals or history_listProcessInstances for completed instances. The word "active" is the only implicit scoping signal.

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