get_top_talkers

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

Annotations already convey read-only, idempotent, and non-destructive behavior, so the description only needs to add operational semantics. It adds ranking basis, grouping keys, and per-exporter scope, which are not visible in annotations. No contradiction exists.

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 no filler. The primary action is front-loaded, grouping follows, and the use-case tagline closes the description efficiently.

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 5-parameter tool with no output schema, the description leaves unclear how the ranking metric is chosen and what the result shape looks like. The purpose is well covered, but the missing metric-control and output expectations make it incomplete.

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%, giving a baseline of 3, but the description introduces ranking metrics (bandwidth, packets, flow count) that have no corresponding parameter in the schema. An agent cannot determine how to select a metric, making the description confusing rather than clarifying.

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 states a specific verb ('Rank'), a specific resource ('NetFlow flows on an exporter'), and concrete ranking metrics (bandwidth, packets, flow count). It also enumerates grouping dimensions, clearly distinguishing this from raw-flow tools like get_network_flows.

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 closing question, 'Answers what is consuming my WAN?', provides an explicit triggering use-case. It does not name alternative tools or give when-not-to-use guidance, but the context is clear enough to route an agent to this tool for top-talker analysis.

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