getDashboardMostActiveEaps

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

With no annotations, the description carries full burden but only states it 'Get's data. It does not disclose that this is a read-only operation, any permissions required, or potential side effects. The minimal behavioral detail (just retrieval) is insufficient for safe invocation.

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?

A single sentence that contains no fluff. It succinctly conveys the primary action (get), the target resource (most active access points), the scope (in a site), and the ordering (sorted by traffic volume).

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?

The description is adequate for a simple retrieval tool with two optional parameters. However, given the lack of an output schema, it would be beneficial to describe the return format (e.g., a list of EAPs with traffic metrics). As it stands, the description leaves the agent guessing about the response structure.

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%, with parameter descriptions already explaining siteId defaults and customHeaders rarity. The tool description adds value by specifying the output sorting (by traffic volume) and the context of 'most active', which goes beyond the schema's parameter-level details.

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 retrieves the most active access points (EAPs) in a site, sorted by traffic volume. The verb 'Get' and resource 'most active access points' are specific, and the sorting detail distinguishes it from sibling tools like getDashboardMostActiveSwitches.

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 does not provide any guidance on when to use this tool versus alternatives. Although it implies the need for a site context (via parameter), there is no explicit mention of when-not-to-use or which sibling tools are better suited for other types of active device queries.

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