Skip to main content
Glama

history_listVariableInstances

Query historic variable instances by process instance ID, variable name, or related filters to retrieve variable name, type, value, and the activity instance that set it.

Instructions

Query historic variable instances by process instance ID or variable name. Returns variable name, type, value, and the activity instance that set it.

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

Input Schema

NameRequiredDescriptionDefault
sortByNo
taskIdInNo
sortOrderNo
maxResultsNo
tenantIdInNo
firstResultNo
variableNameNo
executionIdInNo
variableValueNo
caseInstanceIdNo
includeDeletedNo
variableNameInNo
variableTypeInNo
withoutTenantIdNo
caseActivityIdInNo
variableNameLikeNo
caseExecutionIdInNo
deserializeValuesNo
processInstanceIdNo
processDefinitionIdNo
processInstanceIdInNo
activityInstanceIdInNo
processDefinitionKeyNo
variableNamesIgnoreCaseNo
variableValuesIgnoreCaseNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed25 schema fields changedv1.3.0
    • addedInput schema / properties / activityInstanceIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / caseActivityIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / caseExecutionIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / caseInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / deserializeValues
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / executionIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / firstResult
      Added value: +{
      +  "type": "number"
      +}
    • addedInput schema / properties / includeDeleted
      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 / processInstanceId
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / processInstanceIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / sortBy
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / sortOrder
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / taskIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / tenantIdIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / variableName
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / variableNameIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / variableNameLike
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / variableNamesIgnoreCase
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / variableTypeIn
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / variableValue
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / variableValuesIgnoreCase
      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 burden of behavioral disclosure, yet it only covers the return fields. It says nothing about permissions, pagination behavior (firstResult/maxResults), the meaning of includeDeleted, or how deserializeValues affects results, which matters for a 25-parameter query tool.

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 tight sentences with no filler, and the filter options are front-loaded ahead of the return-value note. The brevity is appropriate in form, even though the content is thin 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?

With no annotations, no output schema, and 25 unlabeled parameters, this is a complex tool that needs substantially more documentation. Mentioning the return fields partially substitutes for the missing output schema, but the overwhelming parameter set leaves the definition inadequate for correct invocation.

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% with 25 parameters, so the description needs to compensate and largely does not. It explains only the processInstanceId and variableName filters and leaves 23 filters undocumented in both the schema and the 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?

The first sentence names a specific verb and resource, 'Query historic variable instances', and scopes it to process instance ID or variable name. That is clear and distinguishes it as the historic-variable read tool, but the description never differentiates it from siblings such as processInstance_getVariable or history_listProcessInstances.

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 explicit statement of when to use this tool versus alternatives. The 'by process instance ID or variable name' phrase implies two entry paths but provides no exclusions, prerequisites, or routing guidance to the sibling getVariable and list tools.

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