ssh-viewer-ensure

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

No annotations provided, so description carries full burden. It reveals singleton-scoping for terminal mode but does not disclose potential side effects (e.g., launching a browser viewer), required permissions, error conditions, or state modifications beyond ensuring existence.

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: first states purpose, second adds key behavioral detail. No extraneous information. Highly efficient.

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?

With no output schema and no annotations, the description is somewhat incomplete. It explains terminal mode behavior but not browser mode, return values, or error scenarios. For a tool with 3 optional parameters, some usage context is missing.

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 provides 100% coverage with descriptions for all 3 parameters. Description adds context about terminal mode singleton-scoping, which enhances understanding of mode and singletonScope. However, overall parameter explanation is already adequate in 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?

The description clearly states the tool ensures a viewer exists for a session, with specific behavior for terminal mode. It distinguishes from sibling ssh-viewer-list which lists viewers, and other session tools.

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 notes terminal mode reuses running viewers, but does not explicitly contrast with browser mode or explain when to use this tool over alternatives like ssh-viewer-list or ssh-session-open. Some guidance is implied but not explicit.

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