Skip to main content
Glama

job_setSuspension

Suspend or resume a specific job by ID so suspended jobs stop executing and can be re-enabled when ready.

Instructions

Suspend or resume a specific job by ID. Suspended jobs will not be executed by the job executor. Resume to re-enable execution.

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": "job_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.1/5.0
Behavior2/5

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

With no annotations present, the description carries the full disclosure burden. It does explain the effect of suspension (executor skips the job) and that resuming re-enables execution, but it omits idempotency, behavior when the job is already in the requested state, effect on an in-flight execution, required permissions, and error behavior for an invalid ID.

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?

Two sentences, front-loaded with the action and target, with no filler. The final clause 'Resume to re-enable execution' is mildly redundant with the preceding sentence but does sharpen the distinction between the two modes.

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?

This is a state-changing operation with no annotations and no output schema, so the description must supply operational detail. It fails to state how suspend vs resume is requested, what the response looks like, or what happens on a nonexistent or already-terminal job — gaps an agent cannot resolve from the one undocumented parameter.

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 coverage is 0% for the single 'id' parameter, so the description must compensate; 'by ID' clarifies that id identifies the job, which is useful. Crucially, it never explains how the caller selects suspend versus resume — no boolean flag is described — leaving the central input semantics ambiguous despite the schema allowing additional properties.

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?

Names a specific verb pair and resource: 'Suspend or resume a specific job by ID'. An agent can identify the target entity (a job instance) distinctly from jobDefinition_setSuspension and processInstance_setSuspension, though the description never explicitly contrasts with those siblings.

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 context is implied by the statement that suspended jobs are skipped by the job executor, which tells the agent why one would call it. There is no explicit guidance on when to prefer job-level suspension over jobDefinition- or processInstance-level suspension, nor any prerequisites or exclusions.

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