Skip to main content
Glama

processDefinition_deleteById

Delete a process definition by ID; set cascade=true to remove running instances, history, and jobs, otherwise deletion fails if instances exist.

Instructions

Delete a process definition by ID. Set cascade=true to also delete running instances, history, and jobs. Fails if instances exist and cascade is false.

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

Input Schema

NameRequiredDescriptionDefault
idYes
cascadeNo
skipIoMappingsNo
skipCustomListenersNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.3.0
    • addedInput schema / properties / cascade
      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 / required
      Added value: +[
      +  "id"
      +]
  2. First observedv1.1.0

TDQS

A3.7/5.0
Behavior4/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 disclose the key destructive consequence: cascade removes running instances, history, and jobs, and the call fails rather than silently deleting when instances exist without cascade. It does not state that deletion is irreversible or what permissions are required, leaving a gap for a destructive operation.

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 cascade effect, then the failure mode. Every sentence adds distinct information with no padding.

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, unannotated tool with no output schema, the description covers the core action and cascade behavior well. However, two of four parameters are undocumented in both schema and description, so an agent cannot know how skipIoMappings or skipCustomListeners affect the deletion.

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%, so the description must explain all four parameters. It covers only 'id' and 'cascade' meaningfully; skipIoMappings and skipCustomListeners are never mentioned, leaving half the parameters with no semantics anywhere.

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 names a concrete verb and resource ('Delete a process definition') and constrains it to 'by ID', which implicitly separates it from the sibling processDefinition_deleteByKey. It stops short of naming an alternative explicitly, so it is clear but not fully differentiated.

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?

It gives a real use condition ('Set cascade=true to also delete running instances, history, and jobs') and a failure condition ('Fails if instances exist and cascade is false'), which effectively tells the agent when to set the flag. It does not address when to prefer deleteByKey or another deletion path, so alternatives are unaddressed.

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