get_top_talkers

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

With no annotations provided, the description carries the burden of behavioral disclosure. It adds useful context by stating that output includes download, upload, and total bytes per device over a recent period. However, it does not explicitly state that this is a read-only query, nor does it disclose sorting behavior or how the 'direction' parameter affects results.

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 two sentences, front-loaded with the action and purpose, and contains no fluff. Every word contributes either to what the tool does or what it returns.

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 tool with two optional parameters and no output schema, the description provides a reasonable overview of the return structure (bytes per device) and time window ('recent period'). However, 'recent period' is ambiguous, and the description does not clarify that 'count' limits the number of results, though this is covered in the 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 description coverage is 100%: both 'count' and 'direction' are described in the input schema. The description adds no additional parameter semantics beyond what the schema already provides, so it meets the baseline for high schema coverage without exceeding it.

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 'Get' and a clear resource ('devices ranked by bandwidth usage'), and introduces the 'top talkers' concept. It distinguishes itself from siblings like get_wan_usage (WAN-level) and get_network_stats (aggregate), though it does not explicitly name an alternative for comparison.

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 intended use case is implied by the description ('Get devices ranked by bandwidth usage'), but there is no explicit guidance on when to prefer this tool over siblings like get_device_flows or get_network_stats. No alternatives, exclusions, or prerequisites are provided.

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