ssh_scan

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It only states the basic scanning behavior, omitting potential side effects (e.g., network load), permissions required, whether it is read-only, or what the output format looks like. This is a significant gap for a tool that actively probes network hosts.

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 a single, front-loaded sentence stating the core action and default behavior. It is concise, contains no redundant words, and efficiently earns its place.

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 that the tool has 5 parameters, no annotations, and no output schema, the one-line description is insufficient. It lacks details on parameter semantics, expected output, and operational caveats. This is a complex scanning tool that requires more thorough documentation for an AI agent to use it 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 schema has zero description coverage for its 5 parameters, so the description must compensate. It only hints at 'port' (default 22) and 'network' (LAN segment), while entirely ignoring 'detail', 'timeout', and 'max_workers'. This provides only partial meaning for a subset of parameters.

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 '扫描' (scan) and resource '局域网网段' (LAN network segment), with a clear objective to discover online hosts with a specified open port (default SSH 22). This clearly distinguishes it from sibling tools like ssh_exec or ssh_list_hosts, which are direct SSH operations.

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 implies usage by stating the tool scans a network to discover SSH-accessible hosts, but it does not explicitly mention when to use it versus alternatives or any exclusions. No guidance is provided on when this should be preferred over other SSH tools.

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