Skip to main content
Glama

processDefinition_restartInstances

Restart one or more process instances of a process definition to re-execute failed or completed instances from a chosen activity.

Instructions

Restart one or more process instances for a process definition. Use to re-execute failed or completed instances from a given activity.

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

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

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. It conveys that this is a mutating re-execution operation, but says nothing about whether the call is synchronous/blocking (critical given the Async sibling), what happens to existing history or variables, required permissions, or whether the restart can be undone. For a destructive-ish mutation with zero annotation coverage, this is thin.

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?

Two short sentences, front-loaded with the action and resource, with no filler. It is efficiently sized, though the second sentence could have been spent resolving the id ambiguity rather than restating the effect.

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?

A mutation tool with no annotations, no output schema, an undocumented parameter, and a synchronous/async twin left undifferentiated. An agent could not reliably decide between this tool and its async sibling, nor know what 'id' to pass, from the definition alone.

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 named only 'id' with 0% schema description coverage, and the description actively creates ambiguity: it says 'for a process definition' yet the action is on process instances, so it is unclear whether 'id' is a definition id, a process instance id, or a list of instance ids ('one or more'). The description does not resolve this.

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 gives a specific verb and resource: 'Restart one or more process instances for a process definition', plus the effect ('re-execute failed or completed instances from a given activity'). That is far more informative than the tool name alone. It does not, however, distinguish itself from the sibling 'processDefinition_restartInstancesAsync', which an agent will see right next to it.

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?

'Use to re-execute failed or completed instances from a given activity' implies a usage context, but there is no explicit when-not guidance, no prerequisites, and no routing to the async sibling. Given that a near-identical async variant exists in the sibling list, the omission of any selection criterion is a meaningful gap.

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