ssh_test_connection

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

No annotations are provided, so the description carries the full burden. It discloses a notable behavioral trait: outputting an RDP script if the server is unreachable/uninstalled. However, it does not mention potential side effects (e.g., known_hosts modification) or detail what happens on a successful connection beyond 'probe target OS.'

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 a single sentence that front-loads the primary action and includes the key fallback behavior. It is concise, readable, and free of unnecessary words.

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 description is incomplete for a tool with no output schema or annotations. It does not specify what is returned on a successful connection (e.g., OS type), what 'uninstalled' means, or any side effects or prerequisites. Agents need more detail to fully understand the tool's behavior.

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?

All 5 parameters have descriptions in the schema (100% coverage), so the baseline is 3. The description adds no additional parameter-level information or context beyond what the schema already provides.

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 action: 'Test SSH connection & probe target OS.' It also mentions a distinct fallback behavior (outputs RDP 1-liner script), which helps differentiate it from sibling tools like ssh_exec or ssh_upload_file. The verb and resource are specific and unambiguous.

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 description implies usage through its purpose, but it does not explicitly state when to use this tool versus alternatives, nor does it mention any exclusions or direct comparisons to sibling tools. The fallback behavior gives some context but no formal guidance.

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