listMostActiveClients

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds that this is a dashboard/overview endpoint returning a ranked list, which is useful context, but it does not disclose how many clients are returned, whether the list is capped or truncated, or what happens when a site has no traffic data.

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?

Three sentences, front-loaded with the core behavior and return fields. The final sentence ('quick overview of top clients by traffic usage') largely restates what the first two sentences already said, so it does not fully earn its place.

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?

There is no output schema, so the description usefully enumerates the returned fields (name, MAC, type, model, wireless status, total traffic), which is exactly what an agent needs to decide relevance. The only meaningful gap is the absence of any indication of how many 'most active' clients are returned.

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 single siteId parameter is already fully documented, including the OMADA_SITE_ID default and the pointer to listSites. The description adds nothing about the parameter, but at full coverage and with the schema handling defaults and discovery, this is adequate; the description's enumeration of return fields partially compensates.

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 names a specific verb and resource ('Get the most active clients in a site') plus the sort order ('sorted by total traffic'), and enumerates the returned fields. That distinguishes it from generic siblings like listClients and from the sibling dashboard tools getDashboardMostActiveSwitches and getDashboardMostActiveEaps, though it never names those alternatives 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?

'This is a dashboard endpoint that provides a quick overview' implies the use case is a summarized view rather than exhaustive enumeration, which implicitly points away from listClients. There is no explicit when-to-use or when-not statement and no named alternative, so the routing guidance is only implied.

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