getDashboardMostActiveSwitches

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'most active' and 'sorted by traffic volume' but does not define the number of results, pagination, or response format. Critical behavioral traits like limit, ordering direction, or potential error conditions are missing.

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 a single, clear sentence that efficiently conveys the tool's purpose. No extra words. However, it could benefit from front-loading key behavior like 'Returns a list of...' but it is still acceptably concise.

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 minimal for a complex dashboard tool. There is no output schema, and the description does not specify return values, limits, or field details. Given the lack of annotations and output schema, the agent lacks crucial information to correctly interpret the results.

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 does not add any parameter-specific meaning beyond what the schema already provides (siteId and customHeaders are well-described in the schema). No additional context is offered.

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 that the tool retrieves the most active switches in a site, sorted by traffic volume. This distinguishes it from sibling tools like getDashboardMostActiveEaps which targets EAPs, and other dashboard tools that cover different metrics.

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 gives no explicit guidance on when to use this tool versus alternatives. While the context of sibling tools implies it is for dashboard-level switch activity, there is no mention of when not to use it or which scenario favors another tool.

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