ssh_session_list

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

Explicitly states read-only nature and that it inspects in-memory state with no side effects. Describes filter behavior and exclusion of closed sessions. Could mention data freshness or error conditions, but sufficient for a list tool.

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 efficient sentences: purpose and attributes, read-only nature, parameter behavior and exclusion rule. No wasted words; critical information front-loaded.

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 param and no output schema, the description covers all essential aspects: what is listed, how it behaves, and parameter specifics. Lists return fields explicitly.

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 description is present ('Filter by server name'), and the description adds 'case-insensitive substring filter on server name' and optional omission, enhancing clarity beyond the schema.

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?

Clearly states it lists active SSH sessions with specific attributes (ID, server, state, etc.). Distinguishes itself from sibling tools like ssh_session_close or ssh_session_start by focusing on listing.

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?

Provides clear context: lists active sessions, optional case-insensitive server filter, omits closed sessions. Lacks explicit comparison to alternatives, but usage is well implied.

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