Skip to main content
Glama

get_traffic_rules

List all traffic rules defined on the UniFi Network Controller to review current traffic management settings before applying changes.

Instructions

List all traffic rules (the modern unified rule system used by ensure_traffic_rule).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full disclosure burden. It disambiguates the rule system and scope ('all', unfiltered), but it does not state whether the operation is strictly read-only, what the returned rule objects look like, or any ordering/pagination behavior. Risk is low for a list operation, but the burden was only partially met.

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

Conciseness5/5

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

A single 15-word sentence with the core action front-loaded and the clarifying context in a parenthetical. Every word earns its place and there is zero redundancy.

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?

For a zero-parameter read-only list tool, the description covers what is returned and which rule system it belongs to, which is sufficient for correct invocation. The main gap is that with no output schema, the structure of each traffic rule is undocumented, which would hinder agents feeding results into update_traffic_rule or delete_traffic_rule.

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

Parameters4/5

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

The tool has zero parameters, which earns a baseline of 4. The description reinforces that there is no filtering by saying 'all traffic rules', which matches the empty schema exactly.

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

Purpose5/5

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

States a specific verb and resource ('List all traffic rules') with explicit scope ('all'). The parenthetical anchors the tool to ensure_traffic_rule and distinguishes it from siblings like get_firewall_rules and get_port_forward_rules, so an agent can pick the right rule-list tool without opening schemas.

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 context is implied: naming ensure_traffic_rule suggests this is the read counterpart in a list-then-ensure/update/delete workflow. However, there is no explicit when-to-use guidance or exclusion of alternatives such as get_firewall_rules or get_port_forward_rules.

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