ssh_diagnose

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

With no annotations, the description carries the full burden. It does disclose the main behaviors—checking agent state, keys, known_hosts, config, and attempting a connection. However, it does not state whether the test connection or diagnostics have side effects, return values, or timeouts, which matters for an unannotated diagnostic tool.

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?

Two sentences deliver purpose, key behaviors, and usage timing without wasted words. The primary purpose is front-loaded, making it easy for an agent to scan and understand quickly.

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 moderately complex diagnostic tool with no annotations and no output schema, the description covers purpose, checks performed, and usage timing. A small gap is the lack of any detail about results or next-step actions, but the core invocation context is sufficiently complete.

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 100%, so the schema already documents both parameters (host and port) adequately. The description adds no additional parameter semantics beyond implying the connection target, so the baseline of 3 is appropriate.

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?

Description states a specific verb ('Diagnose') and resource ('SSH connectivity issues'), and enumerates concrete checks: ssh-agent status, loaded keys, known_hosts, SSH config, and a test connection. This is clear enough to distinguish from most siblings, though it does not explicitly compare itself to the closely related ssh_test tool.

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 explicit timing guidance: use it BEFORE SSH operations if issues are suspected, or AFTER a failed SSH operation to understand failure. This is clear context for when to choose the tool, though it does not name or exclude sibling tools like ssh_test or ssh_known_hosts_fix.

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