Skip to main content
Glama

jobDefinition_setSuspension

Suspend or resume all jobs for a job definition, and optionally apply the change to active job instances by setting includeJobs=true.

Instructions

Suspend or resume all jobs for a job definition. Use includeJobs=true to also suspend/resume active job instances for this definition.

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": "jobDefinition_setSuspension"
  }
}

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

B3.4/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 a genuinely useful behavioral trait — that includeJobs=true extends the change to active job instances, i.e. a cascading side effect on running work. However it never explains how suspend versus resume is selected (there is no visible 'suspended' flag in the schema), nor permission requirements or reversibility, which matters for a state-changing tool.

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?

Two tight sentences with no filler; the core action and scope come first and the optional flag second. Every clause carries information.

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 unannotated state-changing tool with 0% schema coverage and no output schema, the description leaves key operational questions open: how the suspend/resume direction is chosen, what 'id' identifies, and what happens to jobs currently executing. Only the includeJobs cascade is addressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single required 'id' parameter, which the description never explains beyond the resource name. It does introduce 'includeJobs=true' semantics, adding real value, but that flag is not even declared in the schema, creating ambiguity about whether it is accepted and what its default is.

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 pair (suspend/resume) and a precise resource scope ('all jobs for a job definition'), which distinguishes it from the single-job sibling job_setSuspension without naming it. It stops short of explicitly contrasting with siblings, so it is clear but not fully differentiating.

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?

Usage is implied by the scope wording: bulk suspension at the definition level, with includeJobs=true as the option for cascading to active instances. There is no explicit statement of when to prefer this over job_setSuspension or processInstance_setSuspension, and no when-not guidance.

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