Skip to main content
Glama

processInstance_get

Retrieve an active process instance by ID to view its definition key, business key, state, start time, and tenant for monitoring or debugging.

Instructions

Retrieve a single active process instance by ID. Returns id, definitionKey, businessKey, state, startTime, and tenant.

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": {
      "id": "<id>"
    },
    "name": "processInstance_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • addedInput schema / properties / id
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "id"
      +]
  2. First observedv1.1.0

TDQS

A3.8/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 establishes that this is a non-mutating lookup and enumerates the returned fields, but says nothing about what happens when the ID is unknown, when the instance has already ended, whether it requires specific permissions, or what errors look like.

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?

Two tight sentences, front-loaded with the action and scope, then the return payload. Nothing redundant or padded.

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 single-parameter read with no output schema, listing the returned fields is the important contribution and it is present. The remaining gap is error/not-found behavior and the active-versus-history boundary, which are minor for a tool this simple.

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?

Only one parameter exists and its schema has no description (0% coverage). The phrase 'by ID' makes clear that id identifies the process instance rather than a definition or task, which is the key disambiguation among these siblings, but it adds no format or sourcing detail beyond that.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Retrieve) and resource (a single active process instance) scoped by ID, and the word 'single' plus the enumerated return fields separate it from the processInstance_list/count siblings. An agent can distinguish it from processInstance_getVariable and processInstance_getActivityTree, which target sub-resources rather than the instance itself.

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 'active process instance' implies this only covers running instances, hinting that history_listProcessInstances is the path for completed ones, but this is left implicit. There is no explicit when-to-use section and no stated prerequisite for knowing an ID versus looking one up via processInstance_list.

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