getTrafficPriority

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds useful scope by naming which settings are returned (VoIP prioritization and QoS rules for voice/real-time traffic), but it says nothing about whether it returns effective vs configured values, defaults, or per-WAN 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 the resource stated first and the qualifying detail about voice/real-time QoS rules second. No filler, though the trailing clause slightly overlaps the leading phrase.

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 read-only getter with one optional, fully documented parameter and no output schema, the description covers what the tool returns and where it applies. The only meaningful omission is sibling differentiation against the many other QoS-related getters.

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%: the siteId field documents the pattern, the OMADA_SITE_ID default when omitted, and the listSites discovery route. The description adds no parameter meaning beyond that, so the baseline 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 resource and scope: gateway VoIP and traffic prioritization settings for a site, plus the QoS rules for voice and real-time traffic. It is clear what it reads, but it does not distinguish itself from closely named siblings such as getQosPolicy, getGatewayQosClassRules, or getBandwidthCtrlDetail, leaving the agent to guess which QoS getter to call.

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 read-and-inspect nature of the tool; there is no explicit statement of when to call this versus the other QoS and bandwidth tools in the sibling list. An agent can infer it is a configuration lookup, but the choice among near-duplicate siblings is left unresolved.

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