processInstance_setSuspension

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

No annotations provided, so description carries full disclosure burden. It explains the behavioral consequence of suspension (instances cannot advance) and implies reversibility. However, missing safety disclosures typical for mutation operations: no mention of idempotency, required permissions, or what happens to active tasks/jobs.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

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

Three tightly constructed sentences with zero waste. First states purpose, second gives specific parameter instructions, third explains behavioral constraint. Every sentence earns its place with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Adequate for a toggle operation but gaps remain given zero annotations and no output schema. Missing: return value description (likely empty or instance data), error cases (invalid ID, already suspended), and authorization requirements. Could also clarify relationship to job suspension.

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

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

Schema has 0 parameters (baseline 4). Description compensates by clarifying the implied toggle parameter semantics: 'suspended=true to pause' and 'suspended=false to resume,' adding meaning that a bare boolean schema would not convey. Mentions 'by ID' indicating the targeting parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Clear verb ('Suspend or resume') and resource ('process instance by ID'), distinguishing it from siblings like processDefinition_suspendByKey or job_setSuspension. The 'by ID' qualifier helps clarify this targets specific instances rather than batches or definitions.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explains the toggle mechanism (suspended=true/false) and effect ('cannot advance until resumed'), providing implicit guidance on when to use. However, lacks explicit comparison to alternatives like canceling or deleting instances, and doesn't mention prerequisites such as requiring the instance ID.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.