Open persistent SSH session

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

Adds significant context beyond annotations: sessions are clean and get a new id, credentials only come from local OpenSSH config/agent, and passwords/private keys are never accepted as arguments nor read from disk. This safety-related transparency is valuable.

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 focused sentences; every sentence provides useful information without excess. Front-loaded with purpose.

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 key constraints (persistent shell, allowed hosts, credential handling, clean session), but does not describe the return value or lifecycle (how to use/close the session). Given no output schema, a mention of what the tool returns or how the session id is used would be helpful.

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?

Describes the 'host' parameter semantically as an allowed ssh_config Host alias from ssh_hosts, but does not explain the 'name' parameter. Schema coverage is 0%, so the description partially compensates but leaves a gap.

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 states a specific action ('Open') on a specific resource ('a new persistent remote bash shell'), and distinguishes itself from siblings by specifying usage of an allowed ssh_config Host alias from ssh_hosts and clean sessions with new ids.

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?

Provides context that this is for persistent sessions using allowed hosts, but does not explicitly name alternatives like ssh_run or ssh_peek or state when to use them. The 'from ssh_hosts' constraint gives some usage guidance, but it lacks explicit when/when-not.

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