getTrafficPriority

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

No annotations are provided, so the description carries the full burden. The verb 'Get' clearly signals a read-only retrieval, which covers the most important safety fact, and it names the content retrieved. It says nothing about permissions, whether it reflects live vs. configured state, or the shape/multiplicity of the response — acceptable for a read tool but not rich.

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 well-formed sentence with the resource front-loaded and no filler. It is efficient, though it is thin enough that a little more disambiguating content would have earned 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?

For a two-parameter read tool with 100% schema coverage and no output schema, the basics are covered: what it reads and where. What's missing is scope framing relative to the many overlapping QoS getters, which an agent needs here to invoke the right tool.

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%; siteId already documents the OMADA_SITE_ID default and points to listSites, and customHeaders is documented as rarely needed. The description adds no parameter meaning beyond the schema, 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?

States a specific verb and resource: 'Get the gateway VoIP and traffic prioritization settings for a site,' and enumerates what it covers (QoS prioritization for voice and real-time traffic). However, it stops short of differentiating itself from the dense QoS sibling set (getQosPolicy, getQosPolicyRule, getGatewayQosClassRules, getQosMarkingRule, getDscpConfig), so an agent can't tell which one to pick from purpose alone.

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 when-to-use guidance and no exclusions. Given that at least five siblings retrieve QoS/policy/marking configuration, the absence of any routing statement ('use X for per-rule policy, use this for site-level VoIP priority') is a real gap rather than a minor omission.

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