Skip to main content
Glama

history_listProcessInstances

Query historic process instances by key, business key, state, or date range and retrieve IDs, definition keys, start/end times, duration, and status for auditing or reporting.

Instructions

Query historic process instances by key, business key, state (active/completed), or date range. Returns id, definitionKey, startTime, endTime, duration, and state.

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

Input Schema

NameRequiredDescriptionDefault
activeNo
sortByNo
finishedNo
completedNo
sortOrderNo
startedByNo
suspendedNo
variablesNo
maxResultsNo
tenantIdInNo
unfinishedNo
firstResultNo
activityIdInNo
incidentIdInNo
incidentTypeNo
startedAfterNo
finishedAfterNo
startedBeforeNo
withIncidentsNo
caseInstanceIdNo
finishedBeforeNo
incidentStatusNo
incidentMessageNo
withoutTenantIdNo
executedJobAfterNo
withJobsRetryingNo
executedJobBeforeNo
processInstanceIdNo
subCaseInstanceIdNo
withRootIncidentsNo
activeActivityIdInNo
processInstanceIdsNo
incidentMessageLikeNo
processDefinitionIdNo
superCaseInstanceIdNo
executedActivityIdInNo
externallyTerminatedNo
internallyTerminatedNo
processDefinitionKeyNo
rootProcessInstancesNo
subProcessInstanceIdNo
executedActivityAfterNo
processDefinitionNameNo
rootProcessInstanceIdNo
executedActivityBeforeNo
processDefinitionKeyInNo
processInstanceIdNotInNo
superProcessInstanceIdNo
variableNamesIgnoreCaseNo
variableValuesIgnoreCaseNo
processDefinitionKeyNotInNo
processDefinitionNameLikeNo
processInstanceBusinessKeyNo
processInstanceBusinessKeyInNo
processInstanceBusinessKeyLikeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed55 schema fields changedv1.3.0
    • addedInput schema / properties / active
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / activeActivityIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / activityIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / caseInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / completed
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / executedActivityAfter
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / executedActivityBefore
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / executedActivityIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / executedJobAfter
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / executedJobBefore
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / externallyTerminated
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / finished
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / finishedAfter
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / finishedBefore
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / firstResult
      Added value: +{
      +  "type": "number"
      +}
    • addedInput schema / properties / incidentIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / incidentMessage
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / incidentMessageLike
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / incidentStatus
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / incidentType
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / internallyTerminated
      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 / processDefinitionName
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processDefinitionNameLike
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processInstanceBusinessKey
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processInstanceBusinessKeyIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processInstanceBusinessKeyLike
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processInstanceIdNotIn
      Added value: +{
      +  "type": "string"
      +}
    • 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 / startedAfter
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / startedBefore
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / startedBy
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / subCaseInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / subProcessInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / superCaseInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / superProcessInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / suspended
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / tenantIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / unfinished
      Added value: +{
      +  "type": "boolean"
      +}
    • 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 / withIncidents
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / withJobsRetrying
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / withRootIncidents
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / withoutTenantId
      Added value: +{
      +  "type": "boolean"
      +}
  2. First observedv1.1.0

TDQS

C2.8/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It discloses the returned field set, which is genuinely useful given there is no output schema, but says nothing about pagination (firstResult/maxResults), default result limits, sorting behavior, or the fact that all filters are optional and AND-combined.

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 sentences, zero filler, with the query capability front-loaded and the return shape following. Efficient and readable, though the space saved comes at the cost of coverage.

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

Completeness3/5

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

The return-field list partly offsets the missing output schema, which is a real strength. But for a 55-parameter query tool with no annotations and no parameter documentation anywhere, the description is far too thin to let an agent use the tool to its full capability.

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 55 parameters, so the description must compensate and does not. It covers roughly four filter concepts out of dozens, leaving incident filters, tenant filters, variable filters, job-execution filters, termination flags, and sorting/paging parameters entirely unexplained.

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 names a specific verb and resource ('Query historic process instances') and enumerates the main filter axes (key, business key, state, date range), so the agent can distinguish it from runtime siblings like processInstance_list. It stops short of explicitly naming the live/runtime alternative or the other history_* list tools.

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 word 'historic' implies this is for completed/ended instances, but there is no explicit when-to-use statement, no exclusions, and no routing to history_listActivityInstances or processInstance_list. With 55 optional filters, the agent gets no help on which combination is appropriate.

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