ssh_setup_passwordless

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

No annotations are provided, so the description carries the transparency burden. It discloses target file paths and Windows ACL handling, plus verification of key login. However, it omits side-effects like modifying authorized_keys, whether it generates a key pair, or what happens on key mismatch (though forceOverwrite param hints at this). The description provides useful but incomplete behavioral context.

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, well-structured sentence that front-loads the action and includes essential details (target OS paths, ACL mention, verification). Every word adds value, with no redundancy or fluff.

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 tool's complexity (7 params, multi-OS support, verification step), the description covers the core purpose and key behavioral aspects but lacks details on return values, error handling, prerequisites, and side-effects. It is sufficient for a high-level understanding but leaves operational gaps that could be covered by annotations or a more thorough description.

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 baseline is 3. The description adds context about ed25519 key type and deployment destinations, but does not elaborate on parameter semantics beyond what the schema already documents. The keyPath parameter's private/public key ambiguity is not clarified in the description.

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 verb 'Deploy', the resource 'ed25519 public key', and the specific destinations (Linux ~/.ssh/authorized_keys, Windows administrators_authorized_keys with ACLs). It distinguishes this tool from siblings like ssh_remove_passwordless and ssh_test_connection by implying a setup action for passwordless login.

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 the tool is used to enable passwordless SSH login, but it does not explicitly state when to use it over alternatives or provide exclusions. Context from the tool name and siblings suggests usage, but there is no direct guidance on selecting this vs. ssh_test_connection or ssh_remove_passwordless.

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