ssh_remove_job

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

Describes side effects: force=True closes SSH channel and sends EOF but does not guarantee process death. Mentions return values (removed=True/False) and error kind for still-running without force. No annotation contradictions.

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?

Five concise sentences, each adding essential information: core action, conditions, force behavior, return values. No filler, well-organized.

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?

Covers purpose, usage, behavioral traits, parameters, and return values comprehensively. Despite no annotations, the description fully equips an agent to invoke correctly.

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?

Adds meaning beyond schema: explains that force=True closes SSH channel and sends EOF, and that default behavior returns error with kind='still_running'. Schema already describes parameters, but description enriches context.

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 'Drop a job from the registry' with specific details about freeing slots and releasing ring buffers. It distinguishes from sibling tools like ssh_signal (for killing) and ssh_spawn (for creating).

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?

Explicitly explains when to use it (finished/crashed/killed jobs) and when not (still-running without force). Provides alternative: for hard kill, call ssh_signal(KILL) first. Also notes idempotency for cleanup scripts.

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