Skip to main content
Glama

processInstance_count

Count active process instances matching filter criteria to plan pagination before listing results. Filters include variables, tenant, incidents, and process definitions.

Instructions

Count active process instances matching filter criteria. Supports same filters as list. Use before listing to plan pagination.

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

Input Schema

NameRequiredDescriptionDefault
activeNo
suspendedNo
variablesNo
incidentIdNo
tenantIdInNo
businessKeyNo
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. Changed30 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 / 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 / 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 / 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

B3.3/5.0
Behavior3/5

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

Because no annotations are supplied, the description carries the burden of behavioral disclosure. It conveys the read-only, aggregate nature of the tool, and the pagination-planning purpose, but does not say what the return value looks like (a single integer), whether the filter body is sent as a query or POST payload, or whether filters default to all instances.

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?

It uses three short, front-loaded sentences with no filler, and the purpose comes first, then scope, then usage. The one weakness is that it spends a sentence on a pointer to another schema without adding the information a caller actually needs.

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 tool with 30 undocumented parameters, no annotations, and no output schema, the description supplies almost none of the missing context. It does not say what the count is returned as, how filter combinations behave, or what the defaults are, so it is far from complete for this level of complexity.

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?

Schema description coverage is 0% across 30 parameters, so the description had to compensate and does not. 'Supports same filters as list' redirects to a sibling tool's schema, but no filter names, formats, or defaults are described, leaving 30 parameters semantically undocumented.

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+resource: 'Count active process instances matching filter criteria'. This makes it clearly distinguishable from processInstance_list, which returns records rather than a count, and 'active' adds a scope qualifier that the name alone doesn't convey.

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

Usage Guidelines4/5

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

It gives explicit usage guidance: 'Use before listing to plan pagination.' It also points to the sibling tool whose filter semantics apply ('Supports same filters as list'), telling you how to use the filters. It doesn't say when not to use it, but for a count tool that is a minor gap.

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