List SSH Connections

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

Annotations already declare this as read-only and idempotent, but the description adds crucial behavioral detail by explicitly stating that passwords, private keys, passphrases, and credential references are never returned. It also lists the exact fields that are returned, offering valuable transparency beyond the structured 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 two concise sentences that immediately state the action and provide useful details without any fluff. It is well-structured and front-loaded, making it easy to parse.

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?

Given the tool's simplicity and the presence of an output schema plus safety annotations, the description is complete enough. It covers the purpose, the return contents, and the critical security behavior, providing all necessary context for an agent to invoke the tool 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?

The description references the workspace scoping in the phrase 'for a workspace', which implicitly points to the workspaceId parameter, but it does not explicitly detail the parameter's optionality or type beyond what the schema provides. With 0% schema description coverage, the description only partially compensates for the missing parameter documentation.

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 'Lists' with a clear resource ('saved SSH connections') and scope ('for a workspace'), making it easy to understand the tool's function. It also distinguishes itself from sibling tools that create or manage connections by focusing on the read-only list operation.

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 clearly implies the tool is used when you need to list the saved SSH connections for a workspace. It does not explicitly mention alternatives or exclusions, but the purpose is self-evident and distinct from sibling tools, providing adequate usage context.

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