top-clients-by-bandwidth

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

Discloses the authentication requirement (Cloud Connector). However, with no annotations, the description should also state whether the tool is read-only, how data is sorted, or any limitations. The mention of 'limit' parameter is in schema but not elaborated in description.

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 concise sentences covering purpose and a key prerequisite, with no redundancy or extra words.

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?

Covers basic purpose and authentication, but fails to describe expected output format, sort order, or provide guidance relative to siblings. For a tool with no output schema, more context on return values would help.

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%, so baseline is 3. The description repeats the metric enum values but adds no new meaning beyond what the schema already provides.

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?

Clearly states the tool retrieves top N clients by bandwidth on a site, listing the three metric options. Distinguishes from sibling tools which focus on site health, comparisons, or device inventory, none of which target client bandwidth rankings.

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?

Only mentions a prerequisite (requires Cloud Connector). Does not specify when to use this tool versus alternatives like list-hosts or other sibling tools, leaving the agent without guidance on selection.

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