getDashboardMostActiveSwitches

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

No annotations exist, so the description carries full burden. It does not disclose how 'most active' is defined, whether results are paginated, limited to a top N, or the scope of 'site'. The absence of behavioral details (e.g., data freshness, sorting order) undermines agent understanding.

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?

Single sentence, no wasted words. However, it prioritized brevity over completeness; adding a sentence about usage or return structure would improve without harming conciseness.

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?

No output schema exists, yet the description does not hint at return fields (e.g., switch names, traffic volume values). It lacks details on aggregation or limits. Given the tool's data-returning nature, this is a significant gap.

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 informative (e.g., siteId fallback to OMADA_SITE_ID). The tool description adds no new parameter context beyond what's in the schema, so a baseline 3 is appropriate.

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 explicitly states the verb 'Get', the resource 'most active switches', and the criterion 'sorted by traffic volume'. It clearly distinguishes this tool from siblings like getDashboardMostActiveEaps (for EAPs) by specifying switches.

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?

No guidance is provided on when to use this tool versus alternatives. With over 60 sibling tools, especially similar dashboard tools like getDashboardMostActiveEaps, the lack of explicit usage context severely limits agent selection.

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