inventory_host

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

With no annotations provided, the description fully discloses key behaviors: authentication method, no password argument for security, unknown host key rejection with trust_unknown_host option, and that only file paths (not contents) are passed. This gives the agent a complete safety and operation picture.

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 structured well with a clear first sentence stating the main action, followed by details on auth, security, and overrides. It is concise enough but could be trimmed slightly without losing clarity. Every sentence adds value.

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?

Given the complexity (6 parameters, no annotations, output schema exists), the description covers authentication, security constraints, and parameter use for overrides. Missing details on port and user are a minor gap, but overall it provides sufficient context for correct tool use.

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 0%, so the description must compensate. It explains host, hostname, identity_file, and trust_unknown_host, but does not mention the port or user parameters. These are important for SSH connections and their defaults (22 and empty string) are noted in the schema, but the description misses the chance to clarify their role.

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 it SSHs into a host and inventories installed packages, which is a specific verb+resource. It distinguishes from sibling tools (check_cves, fetch_advisory, etc.) that focus on security/compliance, not package inventory.

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 explains authentication via ~/.ssh/config, SSH agent, and default identity files, likening it to running `ssh host` yourself. It clarifies when to use overrides (e.g., local molecule/vagrant instances) and how to handle unknown host keys. It lacks explicit 'when not to use' or comparisons to siblings, but context is clear.

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