Skip to main content
Glama

processDefinition_deleteByKey

Deletes every version of a process definition by key; set cascade=true to remove related instances and history, otherwise deletion fails when active instances exist.

Instructions

Delete all versions of a process definition by key. Set cascade=true to remove all instances and history. Fails if active 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": {
      "key": "<key>"
    },
    "name": "processDefinition_deleteByKey"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYes
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 / key
      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: +[
      +  "key"
      +]
  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 and does disclose key behavior: this is destructive and removes all versions, cascade also wipes instances and history, and non-cascade calls fail on active instances. It omits permission/authorization requirements, irreversibility, and what skipIoMappings/skipCustomListeners change operationally.

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, each adding distinct information, with the core action and its cascade semantic front-loaded. No filler or redundancy.

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?

For an irreversible, high-blast-radius delete with no annotations and no output schema, the description should cover the remaining two parameters and confirm what happens to history, permissions, and the result of the call. Two of four parameters are left with no semantics at all, which is a significant gap for a destructive tool.

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 four parameters, so the description must compensate and only does so for cascade (true removes instances and history; false fails if active instances exist). The two skip* boolean flags — which materially change what is destroyed — are entirely undocumented in both the schema and the description.

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 plus scope: "Delete all versions of a process definition by key." The "by key" qualifier implicitly separates it from the sibling processDefinition_deleteById, though the sibling is never named, so the differentiation is inferred rather than explicit.

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?

Gives conditional guidance for one parameter ("Set cascade=true to remove all instances and history" and the failure case when active instances exist), which tells the agent when the call will be rejected. It offers no explicit guidance on choosing this tool over processDefinition_deleteById when an ID is available, and no prerequisites are 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