ssh_tunnel_create

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

No annotations provided, so description carries full burden. It discloses tunnel lifecycle (keeps running until closed), return value (tunnel ID), and default behavior (localHost). Could mention authentication or limits, but still informative.

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?

Three concise sentences, front-loaded with purpose, no extraneous information. Every sentence earns its place.

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?

Despite no output schema or annotations, the description covers return value, parameter semantics, defaults, and usage for all types. Complete for a tool with 6 parameters and moderate complexity.

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?

Adds significant value beyond schema: explains type parameter options, which parameters are required for each type, defaults, and that remoteHost/remotePort are ignored for dynamic. Schema coverage is 100% but description enriches understanding.

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?

Description clearly states 'Opens a new SSH connection... starts a port-forwarding or SOCKS proxy tunnel', using specific verbs and resource. It distinguishes from siblings like ssh_tunnel_close and ssh_tunnel_list by focusing on creation.

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?

Describes parameter roles for each tunnel type (local, remote, dynamic), necessary parameters, and defaults. Lacks explicit when-to-use or when-not-to-use alternatives, but the context is clear for this creation tool.

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