ssh_tunnel_list

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

With no annotations provided, the description fully discloses behavior: it is read-only and does not create, modify, or close anything. It also details what information is shown (tunnel ID, server, type, etc.), ensuring the agent understands the tool's scope.

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 only two sentences, with the first sentence front-loading the purpose and output fields, and the second sentence explaining parameter usage. No unnecessary words.

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 simple list tool with one optional parameter and no output schema, the description is fully complete. It covers what the tool does, what it returns, and how to use the parameter.

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 schema describes the server parameter as 'Filter by server name'. The description adds that omitting the parameter returns all tunnels across all servers, which goes beyond the schema and clarifies the default behavior.

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 tool lists active SSH tunnels with specific details (ID, server, type, etc.) and explicitly notes it is read-only, distinguishing it from sibling tools like ssh_tunnel_create and ssh_tunnel_close.

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 explains when to use the tool (to list active tunnels) and provides guidance on the optional server parameter, including that omitting it lists all tunnels. It states what the tool does not do (create, modify, close), though it does not explicitly mention alternative tools.

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