ssh_config_lookup

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

No annotations are provided, so the description carries full burden. It mentions reading from ~/.ssh/config, implying a read operation. However, it does not clarify if any network calls or side effects occur, nor does it specify permission requirements. Additional detail like 'read-only' would improve transparency.

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 two sentences, front-loaded with the core action ('Resolve the effective SSH configuration for a host'), and every word adds value. No redundant or filler content.

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 simple single-parameter tool with no output schema, the description covers purpose, input, and source (config file). It could be improved by hinting at the output format (e.g., 'returns a structured object'), but overall it conveys sufficient context for an AI agent to use correctly.

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 coverage is 100% with a single parameter 'host' described as 'SSH hostname or IP address'. The description adds value by explaining what the tool does with that host, including the list of configuration items it resolves, which goes beyond the schema definition.

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 resolves effective SSH configuration for a host and lists specific items (hostname, user, port, etc.). It distinguishes itself from siblings as no other tool in the list provides config lookup functionality.

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 explicitly says 'Use this to understand how SSH will connect to a host,' which provides clear usage context. However, it does not explicitly mention when not to use or provide alternative tools, though the sibling list makes the distinction straightforward.

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