Skip to main content
Glama

processInstance_setVariable

Set a single named variable on an active process instance, overwriting any existing value, to update runtime process data on demand.

Instructions

Set a single named variable on an active process instance. Provide the variable name, value, and type. Overwrites any existing value for that variable.

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

Input Schema

NameRequiredDescriptionDefault
idYes
varNameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.3.0
    • addedInput schema / additionalProperties
      Added value: +{}
    • 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

C2.7/5.0
Behavior2/5

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

No annotations exist, so the description carries the full disclosure burden. It helpfully states that the operation overwrites 'any existing value', which is a real behavioral note about destructive effect. But nothing is said about permissions or authorization, what happens if the instance is not active or does not exist, whether the change is transactional, or what the call returns.

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?

The three short sentences are front-loaded with the core action and contain no filler. The size suits a simple two-parameter mutation, though the third sentence about value and type would earn its place only if the schema supported it.

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?

This is a mutation tool with no annotations and no output schema, so the description must supply behavioral context. Instead it leaves permissions, failure modes, and return behavior undocumented, and it describes input fields (value, type) that the schema does not define, leaving the agent's understanding of the call incomplete or wrong.

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% for the two required parameters, so the description must compensate. It says 'provide the variable name, value, and type', yet the schema declares only id and varName and nothing for value or type. That mismatch actively misleads: it is unclear whether the value and type are silently accepted through the empty additionalProperties, and whether 'id' means the instance id or the variable id.

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 and resource: 'Set a single named variable on an active process instance.' The word 'single' distinguishes this tool from the plural sibling processInstance_setVariables and from the read-oriented getVariable, although neither sibling is named explicitly.

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 description offers no explicit when-to-use or when-not-to-use guidance. It never tells the agent to use the plural variant when setting several variables at once, or to check getVariable first. The only hint is the phrase 'a single named variable', which the reader must infer.

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