cancel_job

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

Since no annotations are provided, the description must disclose behavioral traits. It mentions cancellation and an SSH option but lacks details on side effects (e.g., irreversible, affects dependent jobs, resource release) or requirements for SSH (e.g., configured profiles).

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?

The description is extremely concise: one sentence for purpose and a brief docstring-style list for arguments. Every word 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?

For a simple cancel tool, the description covers the basic purpose and parameters. An output schema exists but is not described. Missing context includes prerequisites (job ownership, permissions) and behavior of the SSH option (e.g., requires SSH profile). Adequate but not comprehensive.

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?

With 0% schema description coverage, the description provides basic explanations for both parameters: job_id as 'SLURM job ID to cancel' and use_ssh as 'cancel via SSH on remote cluster'. However, it lacks details like job_id format or how SSH is configured, so only partially compensates for the missing schema descriptions.

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?

The description clearly states the verb 'cancel' and the resource 'SLURM job', and it distinguishes from sibling tools like submit_job and get_job_status by specifying the action on running or pending jobs.

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?

No guidance is provided on when to use this tool versus alternatives such as get_job_status or submit_job. The description does not mention prerequisites (e.g., job existence, permissions) or scenarios where SSH cancellation is preferred.

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