getGatewayQosClassRules

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 the payload includes classification rules and DSCP/priority markings, which is modest value beyond the annotations, but it says nothing about pagination of results or the default-site fallback behavior.

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 no filler; the resource identifier comes first and the returned content follows. It is efficient, though it stops short of adding any routing or behavioral detail that would make the length fully earned.

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?

This is a read-only getter with a fully documented three-parameter schema and annotations covering safety, and no output schema, so the description need not describe return values in detail. Its statement of returned content plus the schema's pagination and site defaults make it usable as-is, with only sibling differentiation missing.

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%, with page, pageSize, and siteId all documented in the schema itself, including the OMADA_SITE_ID fallback and the listSites discovery hint. The description contributes no additional meaning about these parameters, so the baseline of 3 applies.

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 gateway QoS class rules for a site') and enumerates the content returned (traffic classification rules, DSCP/priority markings), so the agent knows exactly what is fetched. It does not distinguish itself from domain-adjacent siblings such as getQosPolicy, getTrafficPriority, or getAppControlRules, which an agent could easily confuse it with.

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?

There is no statement of when to call this rather than getQosPolicy or getTrafficPriority, and no prerequisites or exclusions are given. The only context is implicit in the word 'gateway', leaving the agent to infer selection criteria.

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