ssh_diagnose

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

No annotations provided; description enumerates checks but does not disclose whether operations are read-only, side effects (e.g., modifies known_hosts), or rate limits. Could be more transparent about non-destructive nature.

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 with no redundancy. Front-loaded with action and context, then usage guidance. Highly efficient.

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 and usage well, but lacks description of output/return value (e.g., diagnostic report format). With no output schema, the description bears responsibility for this information.

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%; both parameters are documented. The tool description does not add additional meaning beyond what the schema provides (e.g., specifying format for host).

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 diagnoses SSH connectivity issues and lists specific checks (ssh-agent, keys, known_hosts, config, test connection). It distinguishes from siblings like ssh_test by focusing on comprehensive diagnosis.

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 advises using before SSH ops if connectivity issues suspected or after failure. Lacks explicit mention of alternatives, but context is sufficient.

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