create_ssh_connection

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

With no annotations, the description carries full burden but only states the action. It does not disclose behavioral traits such as whether the connection is established immediately, failure handling, or side effects like credential storage.

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 extremely short and front-loaded, but it sacrifices necessary detail. It is concise but under-specified for a creation tool.

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 presence of a nested object parameter and no output schema or annotations, the description is incomplete. It does not explain what happens after creation, how to use the connection, or error states.

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?

The tool description adds no meaning beyond the input schema, which has 50% coverage. For instance, 'connectionId' is not explained as a user-defined identifier, and the schema already describes 'connectionConfig' fields.

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 action 'Create a new SSH connection', which distinguishes it from sibling tools like 'delete_ssh_connection' and 'ssh_execute'. However, it lacks specificity about what 'creating' entails (e.g., persistent session or stored configuration).

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?

No guidance is provided on when to use this tool versus alternatives like 'update_ssh_connection' or 'validate_ssh_connection'. There is no mention of prerequisites or typical workflow.

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