getDashboardMostActiveEaps

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered and the description's added value is the traffic-volume sort order. However, it never states the measurement window for 'traffic volume' or how many EAPs are returned, which are the key behavioral facts an agent needs to interpret the output.

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 front-loaded sentence with zero filler that states the resource, the scope, and the ordering in one pass.

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?

For a one-parameter read-only dashboard tool with no output schema, the definition is nearly sufficient, especially with a fully documented parameter. The remaining gap is that 'traffic volume' is undefined in time window or result count, which affects how an agent reports the data.

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% and the sole siteId parameter is fully documented in the schema, including the OMADA_SITE_ID default fallback and the listSites discovery hint. The description only restates the site scoping at a high level and adds no syntax or format meaning beyond the schema.

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 pairs a specific verb (Get) with a specific resource (most active access points / EAPs) and adds the ranking criterion (sorted by traffic volume) plus the site scope. It is easily separable from getDashboardMostActiveSwitches and listMostActiveClients by resource type, though neither sibling is named explicitly.

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?

Usage is only implied by the 'most active' framing; there is no statement of when to pick this over getDashboardMostActiveSwitches, getDashboardTrafficActivities, or listMostActiveClients, and no prerequisites are mentioned. The schema's siteId description does route discovery to listSites, which partially compensates.

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