Skip to main content
Glama

processInstance_setVariables

Add or update multiple variables on an active process instance in one call by supplying a map of typed variable names to values; existing variables are overwritten.

Instructions

Add or update multiple variables on an active process instance in a single call. Provide a map of variable names to typed values. Existing variables are overwritten.

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

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

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

TDQS

B3.1/5.0
Behavior3/5

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

With no annotations at all, the description carries the full behavioral burden. It does disclose one important trait — 'Existing variables are overwritten' — which tells the agent this is a destructive mutation, but it omits atomicity (whether a partial failure leaves some variables set), permission requirements, and what happens with type mismatches.

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?

Three short sentences with no filler, and the core action plus its overwrite consequence are front-loaded. Nothing is padded, though the payload sentence would be better spent on specifics the schema lacks.

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, no output schema, and 0% schema description coverage, so the description should be doing much more. It leaves the variables-map parameter (the whole point of the call) undefined relative to the schema and says nothing about the return value or failure behavior.

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 coverage is 0% and the only declared parameter ('id') is undocumented in both schema and description. The description describes a 'map of variable names to typed values' payload that does not appear in the schema at all, and gives no guidance on how types are encoded (raw JSON, strings, type suffixes).

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 ('Add or update') and resource ('multiple variables on an active process instance'), and 'in a single call' signals the batch nature that separates it from the singular processInstance_setVariable. It stops short of explicitly naming that sibling, so the differentiation is inferential rather than stated.

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?

'On an active process instance' implies a precondition (the instance must be running), which is useful. However, there is no explicit when-to-use versus when-not guidance, no mention of choosing this over the singular setVariable tool, and no guidance for the similarly named task_setVariables alternative.

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