get_ssh_tunnel_info

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

The description explicitly states that secrets are redacted, which is a critical behavioral note. It also advises using test_connection to verify the tunnel actually connects, adding transparency about the tool's output limitations. No contradictions with annotations.

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 concise, consisting of two clear sentences. It avoids unnecessary detail and directly conveys the tool's purpose, usage context, and important behavioral notes.

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?

The description is complete for this tool: it explains what is returned (the SSH tunnel profile), notes that secrets are redacted, and provides guidance on how to verify connectivity. No output schema exists, so no return value explanation is required.

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 single parameter connectionId is fully described in the schema as 'The ID or name of the database connection'. The description adds no additional semantic detail beyond what the schema already provides, so a baseline score of 3 is appropriate.

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 (Get), the resource (SSH tunnel / jump host profile), and the association with a database connection. It distinguishes this tool from siblings like get_connection_info by focusing specifically on the SSH tunnel 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?

The description provides context for when to use the tool (to retrieve SSH tunnel configuration) and suggests using test_connection to verify connectivity. It could be more explicit about when not to use this tool, but the alternative is mentioned.

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