Skip to main content
Glama

processInstance_delete

Cancel an active process instance by ID and optionally record a deletion reason in history. Use it to stop running instances and receive confirmation on success.

Instructions

Delete (cancel) an active process instance by ID. Accepts an optional deletion reason that is recorded in history. Returns confirmation on success.

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

Input Schema

NameRequiredDescriptionDefault
idYes
skipIoMappingsNo
failIfNotExistsNo
skipSubprocessesNo
skipCustomListenersNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.3.0
    • addedInput schema / properties / failIfNotExists
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / id
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / skipCustomListeners
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / skipIoMappings
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / skipSubprocesses
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / required
      Added value: +[
      +  "id"
      +]
  2. First observedv1.1.0

TDQS

B3.2/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; it does disclose that the reason is recorded in history and that confirmation is returned, which is real behavioral value. It omits the important parts: what the four skip*/failIfNotExists flags change about execution, whether subprocesses and listeners are cascaded by default, and whether the operation is reversible.

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, front-loaded with the core action and free of padding. The closing 'Returns confirmation on success' is near-redundant, but the overall size is appropriate for the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, five-parameter operation with no annotations and no output schema, the description is thinner than it should be: the four boolean control flags and their default behavior are undocumented. It does cover the identity parameter, the history effect, and the response shape, which keeps it from being inadequate.

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% across 5 parameters, so the description must compensate, and it largely does not: skipIoMappings, failIfNotExists, skipSubprocesses, and skipCustomListeners are never explained. Worse, it describes an 'optional deletion reason' parameter that does not exist in the input schema, which is actively misleading about the interface.

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 first sentence states a specific verb and resource ('Delete (cancel) an active process instance by ID') and clarifies that delete means cancel, which disambiguates it from state-changing siblings such as processInstance_setSuspension. It is clear enough to select without opening the schema, though it never names a sibling as an alternative.

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?

The phrase 'active process instance' implies the operation only applies to running instances, which is useful scoping. However, there is no explicit guidance on when to delete versus suspend (processInstance_setSuspension) or when to use the definition-level delete siblings, and no mention of prerequisites or required permissions.

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