traffic_volume

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

No annotations are provided, so the description carries the full burden and largely drops it. It does not state that this is a read-only query, does not mention authentication or data-source constraints (which flow logs), and gives no behavioral context beyond the enumeration of group_by values.

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?

Two short sentences, front-loaded with the core purpose and followed by the only non-obvious constraint. No filler, though it is terse to the point of under-specifying the remaining parameters.

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?

An output schema exists, so return values need not be described. But with zero schema description coverage, the description only compensates for one of three parameters and omits the read-only nature and data-window semantics that limit/since_minutes imply.

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 0% and the schema declares no enums, so the description's enumeration of valid group_by values (VmName, VnetName, SrcIp, DstIp, DstPort, Direction) is genuinely valuable. However, the other two parameters (limit, since_minutes) are left entirely undocumented in both places.

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?

States a specific resource and metric: 'Top talkers by bytes from the flow logs.' This distinguishes it from siblings like search_flows and top_denied_traffic, though the sibling differentiation is only implicit in the word 'bytes' rather than explicitly stated.

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?

Usage is implied by the description ('top talkers by bytes'), but there is no explicit when-to-use guidance, no mention of when to prefer top_denied_traffic or search_flows, and no prerequisites or exclusion conditions.

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