Connect SSH tunnel

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

Annotations already declare readOnlyHint=false and idempotentHint=false, and the description adds no new behavioral context about side effects, required setup, authentication, or outcomes. It merely restates the connect action without going beyond the structured metadata.

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 text is short and the key verb is front-loaded, but the second sentence largely restates the first. It is not bloated, yet the redundancy means the description is not as efficient as it could be.

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 tool with three undocumented parameters and no output schema, the description lacks enough information for an agent to reliably invoke it. It does not explain how to identify the target tunnel, what a successful connection entails, or what errors or side effects to expect. Sibling tool names alone cannot fill these gaps.

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?

All three parameters (name, tunnelIndex, sourceHostId) are undocumented in the schema, and the description does not clarify how to specify the tunnel. The phrase 'specified configuration' does not explain which parameter selects the tunnel, whether they are alternatives, or what values are expected. With 0% schema coverage, the description fails to compensate.

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 uses a specific verb ('Connect') and resource ('SSH tunnel') and clearly states that it establishes an SSH tunnel connection. It is distinguishable from siblings like termix_tunnels_disconnect_ssh_tunnel and the preset-management tools, though it remains generic about what configuration is used.

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 such as termix_tunnels_create_client_tunnel_preset or termix_tunnels_disconnect_ssh_tunnel. There are no prerequisites, exclusions, or conditions stated. Usage context is only implied by the tool's name and title.

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