test_ssh_connection

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

With no annotations, the description carries the full burden. It discloses the key behavioral trait that no command is run and that the return value indicates success/failure, but it omits details about error behavior (e.g., unknown host alias, unreachable host) and whether any side effects exist.

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 compact and well-structured with a one-sentence summary, clearly labeled Args, and Returns. Every line earns its place without fluff or repetition.

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?

The tool is simple with only two parameters, and the description covers purpose, parameters, and return behavior. It is complete enough for an agent to invoke correctly, though it could mention behavior on failure (e.g., exception vs. false return) for even stronger guidance.

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 description coverage is 0%, so the description fully compensates. It explains that hostname is an 'alias from SSH config' and timeout is 'connection timeout, seconds (default 30, max 300)', adding crucial meaning not present in the schema.

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 tool's purpose with a specific verb ('Test') and resource ('SSH connectivity to a host'). It also distinguishes itself from the sibling tool execute_ssh_command by adding 'without running a command'.

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?

The phrase 'without running a command' provides clear context for when to use this tool versus execute_ssh_command. It does not explicitly mention alternatives like list_ssh_hosts or get_host_info, but the core use case is well implied.

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