ssh_guide

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

With no annotations, the description must carry behavioral disclosure. It states the guide covers non-working paths and saves attempts, which is useful context, but it never explicitly says the tool has no side effects and only returns documentation. For a guide, this is inferable, so the gap is moderate.

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 short sentences with purpose first locked in the first sentence, followed by concrete usage triggers and a value proposition. No filler or repetition.

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 single optional parameter and no output schema, the description is sufficient: purpose, when to use it, and topic categories are available. It does not describe the return shape, but that is not critical for a guide tool.

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% with topic values fully described in the parameter description. The tool description adds situational context (when to read which guide) but no new meaning about the topic parameter itself, so it stays at the baseline.

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 identifies the tool as a detailed guide ('Подробное руководство') for the SSH toolset, which is clearly distinct from the operational sibling tools. It does not explicitly say it returns documentation text, but 'Прочитайте нужную тему' makes the informational purpose clear.

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 gives explicit triggers: read before 'first interactive session, first tunnel, or saving a new server'. It does not state when-not or name alternatives, but as the only guide among operation tools, the when-to-use context is clear.

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