jobDefinition_setSuspension

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

Lacks annotations, so description must carry full burden. Mentions both suspension and resumption, but does not disclose side effects, required permissions, or reversibility details. The reference to a non-existent parameter reduces confidence in the behavioral description.

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?

Two sentences, appropriately brief and front-loaded with the primary action. However, the second sentence is wasted describing a phantom parameter, slightly reducing the value of the limited space.

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 state-toggle tool, mentioning both suspend and resume actions. However, lacks information about return values, error conditions, or the actual parameter structure due to the empty schema and missing output schema.

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?

Input schema has 0 parameters (baseline 4), but the description incorrectly references an 'includeJobs' parameter that is not defined in the schema. This creates a mismatch between documented and actual interface, misleading the agent about required inputs.

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?

States a clear action (suspend/resume) and target resource (all jobs for a job definition). Implicitly distinguishes from sibling 'job_setSuspension' (individual jobs) and 'processInstance_setSuspension' via the resource name in the function title.

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?

Attempts to provide usage guidance regarding 'includeJobs=true', but this parameter does not exist in the empty input schema, creating confusion. Fails to explicitly compare against alternatives like 'job_setSuspension'.

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