Skip to main content
Glama

processInstance_setSuspension

Suspend or resume a process instance by ID to pause execution or allow it to continue; suspended instances cannot advance until resumed.

Instructions

Suspend or resume a process instance by ID. Set suspended=true to pause execution, suspended=false to resume. Suspended instances cannot advance until resumed.

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

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

A3.7/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 usefully discloses that the operation is reversible (resume) and that suspended instances cannot advance, but says nothing about permissions required, what happens when the instance is already in the requested state, or side effects on jobs/tasks under the instance.

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?

Three short sentences, front-loaded with the action, then the flag semantics, then the consequence. No filler and nothing redundant.

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 simple state-toggle tool with one declared parameter and no output schema, the description covers purpose, both flag values, and the runtime effect. Missing only operational context such as permission requirements and idempotency/error behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the schema declares only 'id', so the description is the sole source of meaning for the 'suspended' flag — it explains exactly what true and false do. The 'id' parameter is only loosely covered ('by ID'), and the fact that 'suspended' is not declared in the schema is a gap the description mitigates but does not fully resolve.

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 states a specific verb pair and resource: 'Suspend or resume a process instance by ID'. This is clearly distinguishable from the job/jobDefinition siblings that share the setSuspension verb, since the resource is named explicitly. It stops short of a 5 only because it never names a sibling or boundary condition against them.

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: pause execution with suspended=true, resume with false. There is no guidance on prerequisites (e.g., the instance must exist and be running), no exclusions, and no named alternatives for related state-change operations.

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