Skip to main content
Glama

processInstance_getVariable

Retrieve a single named variable from an active process instance, returning its value, type, and scope for inspection or debugging.

Instructions

Retrieve a single named variable from an active process instance. Returns the variable value, type, and scope.

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>",
      "varName": "<varName>"
    },
    "name": "processInstance_getVariable"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
varNameYes
deserializeValueNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.3.0
    • addedInput schema / properties / deserializeValue
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / id
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / varName
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "id",
      +  "varName"
      +]
  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?

With no annotations present, the description carries the full disclosure burden. It does usefully disclose the return shape (value, type, scope), which matters since there is no output schema, but it says nothing about permission requirements, behavior for a missing variable name, or how deserialization affects the returned value.

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 short sentences, purpose first, return information second, with no filler or redundant restatement of the tool name.

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?

For a three-parameter read tool with no annotations, no output schema, and no schema descriptions, the definition covers purpose and the general return shape but leaves the deserializeValue flag and failure modes unexplained. Adequate to initiate a call, not complete enough to call confidently in edge cases.

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%, so all three parameters rely on the description for meaning. "named variable" and "active process instance" loosely map to varName and id, but deserializeValue is never explained, and no format or naming-convention guidance is offered for any parameter.

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 ("Retrieve a single named variable from an active process instance"), and the word "single" plus "active" implicitly separates it from the plural processInstance_getVariables. It does not name the sibling outright, so differentiation is inferential rather than explicit.

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?

Usage is implied rather than stated: "single named variable" suggests fetching one known variable, while processInstance_getVariables would be the bulk alternative, but neither is named nor is a when-not condition given. The "active process instance" scope is the only real constraint communicated.

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