Skip to main content
Glama

processDefinition_suspendByKey

Suspend or activate a process definition by key, preventing suspended definitions from starting. Enable includeProcessInstances to also suspend all running instances.

Instructions

Suspend or activate a process definition by key. Suspended definitions cannot be started. Set includeProcessInstances=true to also suspend all running instances.

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

Input Schema

NameRequiredDescriptionDefault
keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.3.0
    • addedInput schema / additionalProperties
      Added value: +{}
    • addedInput schema / properties / key
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "key"
      +]
  2. First observedv1.1.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations, so the description carries the full burden: it usefully discloses that suspension blocks starting and that includeProcessInstances cascades suspension to all running instances, which is important side-effect context. It omits whether the cascade also applies in the activate direction, what permissions are required, and whether the change 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the action, followed by the key behavioral constraint and the optional flag. No filler.

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 one-parameter tool with no output schema the description covers the essentials, but the phantom includeProcessInstances parameter leaves the agent with a faulty mental model of the interface, and the effect of the activate direction on running instances is unspecified.

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 coverage is 0% for the single 'key' parameter, which the description only gestures at with 'by key' rather than explaining its format or source. Worse, it instructs the caller to set includeProcessInstances=true, a parameter that does not exist in the input schema, which is actively misleading.

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 pair (suspend or activate) and the resource (a process definition) scoped by key, which distinguishes it clearly from siblings like deleteByKey or getByKey. It does not explicitly name a sibling, but the purpose is unambiguous.

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?

Implies usage via 'Suspended definitions cannot be started', giving a reason to call it, and offers the includeProcessInstances option. However, it never states when to choose definition-level suspension over instance-level suspension or jobDefinition_setSuspension, nor any prerequisites.

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