ssh_password_save

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

The description goes well beyond annotations by disclosing that the password is never written to profiles, jobs, dashboard state, logs, command arguments, or environment metadata, and that it stores only specific fields in the RunBeacon profile. This is valuable behavioral context not present in annotations.

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 three sentences, front-loaded with the primary action, followed by a security-critical detail. Every sentence earns its place with no redundancy.

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?

The description gives a clear behavioral model of what is stored and what is not, which is sufficient for a save operation. However, it omits any mention of return values or success indication, and the lack of an output schema leaves some ambiguity, though not critical.

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 91%, so the input schema already describes parameters well. The description adds little beyond restating the preference for passwordEnvVar and the memory-only nature of password, which are already in the schema descriptions.

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 a specific verb+resource: 'Store an SSH password' and 'create a safe RunBeacon profile'. It distinguishes from siblings like ssh_password_delete and github_token_save by focusing on SSH password storage and its unique profile contents.

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 provides no guidance on when to use this tool vs alternatives such as credential_profile_save or github_token_save. The only usage guidance ('Prefer passwordEnvVar') concerns parameter selection, not tool selection.

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