Skip to main content
Glama

List traffic routes

unifi_list_traffic_routes
Read-only

List policy-based traffic routes to see which clients, networks, and destinations are sent through a specific WAN or VPN, including kill switch and next hop.

Instructions

List traffic routes (policy-based routing): which clients or networks, and which destinations (domains, IPs, regions or all internet), are sent out a given WAN or VPN client network, with kill switch and next hop. Plain destination-based static routes are in unifi_list_routes.

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_traffic_routes"
  }
}

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

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and idempotentHint=false, so the safety profile is covered; the description adds domain-level context about what the returned objects carry (kill switch, next hop, WAN vs VPN client network target). It does not mention result volume, pagination, or why the 'raw' flag matters for payload size, which would be the remaining behavioral gap.

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?

Two sentences, both load-bearing: the first defines the resource and its fields, the second disambiguates from the nearest sibling. The first sentence is dense with parenthetical lists but remains readable and front-loads the core noun phrase 'traffic routes (policy-based routing)'.

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 read-only list tool with full schema coverage and no output schema, the definition supplies enough: what the records represent, which fields matter conceptually, and where the lookalike data lives. Missing only return-shape specifics such as volume/pagination, which is a minor gap given the 'raw' flag hints at large payloads.

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% and all four parameters (raw, site, fields, search) are documented in the schema itself, including examples and a cross-reference to unifi_list_sites. The description adds no parameter-specific meaning, so the baseline of 3 applies.

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 traffic routes) and immediately qualifies it as policy-based routing, enumerating the matching dimensions: source clients/networks, destination domains/IPs/regions/all internet, target WAN or VPN client network, kill switch, next hop. It also explicitly contrasts with the sibling unifi_list_routes, so an agent can distinguish the two without opening either schema.

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

Usage Guidelines4/5

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

The final sentence explicitly routes the agent: plain destination-based static routes belong in unifi_list_routes, implying this tool is for policy-based traffic routes. That is a clear alternative-selection rule, but there is no positive guidance on when an agent would want traffic routes (e.g. debugging client egress or verifying kill-switch behavior) and no exclusions beyond the one sibling.

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