ssh_tunnel_list

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

No annotations provided, but the description explicitly states 'Read-only: it does not create, modify, or close anything', providing clear behavioral transparency beyond the tool's function.

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?

Two sentences, each serves a clear purpose: first states the function and list of fields, second clarifies read-only nature and 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?

No output schema, but description lists the fields returned. Given the tool's simplicity and the sibling tools context, it provides enough information for an agent to invoke it correctly.

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 100% (one parameter with description). The description adds value by explaining the effect of omitting the parameter ('list every active tunnel') and that it filters to one server.

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 specific verbs ('lists') and clearly states the resource ('active SSH tunnels'), listing many fields. It distinguishes from siblings like ssh_tunnel_create and ssh_tunnel_close by stating it is read-only.

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?

It explains when to use (to list active tunnels) and what it does not do (create/modify/close). The optional server parameter usage is explained. Could explicitly mention alternatives, but context is clear with sibling names.

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