apic_get_top_talkers

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

No annotations are provided, so the description carries the full burden. It states it returns a list of top traffic generators but does not disclose any behavioral traits (e.g., read-only nature, side effects, authentication requirements). The description is incomplete regarding tool behavior.

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 concise (two short paragraphs), front-loaded with the primary purpose, and enumerates returned fields without superfluous content. Every sentence adds value.

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?

Given no parameters and no output schema, the description adequately explains what the tool does and what it returns. It covers the essential context for a simple query tool. Minor improvement would be stating it is a read-only operation.

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?

The input schema has zero parameters, so schema coverage is trivially 100%. The description does not need to add parameter information. Per rules, 0 parameters = baseline 4.

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 tool identifies top network conversations and lists specific returned data (tenant/EPG, bytes, packets, utilization, ranking). Though it doesn't explicitly differentiate from sibling tools like apic_get_traffic_analysis, the verb 'identify' and resource 'top talkers' provide specific purpose.

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 description mentions it is 'useful for identifying bandwidth consumers and traffic patterns', implying usage context, but lacks explicit when-to-use or when-not-to-use guidance and does not distinguish from nearby siblings.

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