Skip to main content
Glama

List static routes

unifi_list_routes
Read-only

Lists user-defined static routes with destination, type, next hop, distance, and enabled status; set active to return the live routing table including system routes.

Instructions

List user-defined static routes: destination CIDR, type (nexthop, interface or blackhole), next hop or interface, distance and enabled. With active: true, return the gateway's live routing table instead, system routes included (stat/routing; not on every version). To send chosen clients or destinations out a particular WAN or VPN use unifi_list_traffic_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_routes"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
activeNoReturn the active routing table (including system routes)
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.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely non-obvious behavior: the 'active' flag switches the data source to the live routing table and includes system routes, with a caveat that this is unavailable on some firmware versions. It does not discuss permissions, result volume, or pagination, keeping it short of a 5.

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?

Three tight sentences: what is returned, the mode-switch caveat, then the sibling redirect. The list of returned fields is front-loaded and nothing is redundant.

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

Completeness5/5

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

There is no output schema, so the description must carry the return shape, and it does by naming the fields returned. Combined with the annotations and a fully described 4-parameter schema, an agent has everything needed to call this correctly.

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?

Schema coverage is 100%, so the baseline is 3, but the description goes slightly beyond it by explaining the consequence of 'active' (live routing table, system routes included) and by flagging the version-dependent availability of that mode. The site, fields, and search parameters are left entirely to the schema, which is acceptable given full coverage.

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 user-defined static routes') and enumerates the returned fields (destination CIDR, type, next hop/interface, distance, enabled). It also explicitly distinguishes itself from the sibling unifi_list_traffic_routes, which handles WAN/VPN steering.

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

Usage Guidelines5/5

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

Gives an explicit conditional mode ('With active: true, return the gateway's live routing table instead') and names the alternative tool with the exact scenario that selects it ('to send chosen clients or destinations out a particular WAN or VPN'). No inference required.

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