get_top

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

Minimal disclosure. No annotations exist, so description should cover SSH authentication, potential timeouts, or that it returns process snapshot text. Only states 'snapshot' without details.

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?

One sentence, 10 words, front-loaded action. Could be more informative without being verbose; borderline under-specified.

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 7 parameters and no schema descriptions, the tool description is insufficient for correct invocation. Lacks security and usage context despite having an output schema.

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 0% and description adds no parameter explanation. Host, user, password, key_path, timeout, accept_new_hostkey are all undocumented.

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 action ('collects top's snapshot') and the resource ('remote Linux host via SSH'). It distinguishes from sibling tools like get_disk_free or get_uptime by specifying the top command.

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?

No guidance on when to use this tool vs alternatives like get_ps_aux_top_cpu_consumers. No mention of prerequisites or context.

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