Skip to main content
Glama

List QoS rules

unifi_list_qos_rules
Read-only

Lists QoS rules from the UniFi policy table so you can inspect objectives, rate limits, applied clients or networks, and matching apps, IPs, regions, or domains.

Instructions

List QoS rules from the policy table (recent Network 9.x/10.x with a UniFi gateway): objective (LIMIT, PRIORITIZE or LIMIT_AND_PRIORITIZE), rate limits in kbps, the clients/networks they apply to and the apps, IPs, regions or domains they match.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "unifi_list_qos_rules"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full controller objects (large)
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds real value by disclosing the returned content (objective values LIMIT/PRIORITIZE/LIMIT_AND_PRIORITIZE, rate limits in kbps, targets, match criteria) and a version prerequisite; it omits pagination/result-size behavior, which matters given the 'raw' parameter returns large objects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single tightly packed sentence with the resource and its environment constraint front-loaded and no filler. The trailing parenthetical enumerating objectives and match types is long but each item earns its place by describing output content that has no output schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so well (objective, kbps limits, applied clients/networks, match targets). Combined with 100%-covered parameters and read-only annotations, an agent has enough to call it correctly; only result-size/pagination behavior is unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so raw, site, fields and search are fully documented in the schema and the baseline of 3 applies. The description contributes nothing about these parameters — no note that 'search' matches the names/IPs/domains the rules target, nor that 'raw' should be avoided for bulk listings.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ("List QoS rules") and scopes it to "the policy table" on recent Network 9.x/10.x controllers with a UniFi gateway, which separates it from the firewall/NAT/traffic rule listers. It does not explicitly say how it differs from a close sibling like unifi_list_traffic_rules, so it stops just short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied via the environment prerequisite (recent Network 9.x/10.x plus a UniFi gateway), which is genuinely useful for knowing when this call will return data. There is no explicit when-to-use/when-not guidance and no named alternative for older controllers or for non-QoS policy inspection.

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