Skip to main content
Glama

processDefinition_restartInstancesAsync

Restart many process instances asynchronously and return a batch job, preventing request timeouts during bulk restarts.

Instructions

Restart process instances asynchronously (returns a batch job). Use when restarting many instances to avoid timeout.

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": "processDefinition_restartInstancesAsync"
  }
}

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.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does add real value: it discloses async execution and that a batch job is returned. It omits important mutation behavior — whether running instances are terminated, whether the operation can be cancelled, what permissions are needed, and how to track the returned job.

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 tight sentences, no filler, with the async/batch-job characteristic front-loaded before the usage hint. Every clause earns its place.

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 do more. It neglects the destructive implications of restarting instances and gives no pointer on how the returned batch job is inspected (e.g. via jobDefinition_get or jobDefinition_list siblings).

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?

The single required parameter is documented at 0% schema coverage and the description adds nothing about it. The plural 'instances' against a single string 'id' leaves genuine ambiguity about whether this is a process instance id, a definition id, or a filter — a gap the description should close.

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 (restart process instances) plus the key differentiator 'asynchronously (returns a batch job)'. That adjective is what separates it from the synchronous sibling processDefinition_restartInstances, though the sibling is never 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Use when restarting many instances to avoid timeout' gives a concrete selection condition tied to scale. It stops short of explicitly naming the synchronous alternative for the few-instance case, so the routing is implied rather than stated.

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