Skip to main content
Glama

List WAN connections

unifi_list_wans
Read-only

Lists WAN connections with type, VLAN, IP/PPPoE, DNS, failover, load balancing, Smart Queues, ISP speeds, and live health to verify uplinks.

Instructions

List WAN connections with connection type, VLAN, static IP or PPPoE user, DNS, failover and load balancing, Smart Queues and ISP speeds, plus live WAN health (status, WAN IP, ISP, uptime).

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

Input Schema

NameRequiredDescriptionDefault
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.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 new context by disclosing that results include live WAN health (status, WAN IP, ISP, uptime), which explains why idempotentHint is false and signals the data is real-time rather than static config. Auth requirements, rate limits, and pagination are not covered.

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 front-loaded sentence with no filler; the resource and scope come first and the returned attribute list follows. The field enumeration is dense but earns its place given there is 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 usefully characterizes the return payload (config attributes plus live health), and all three optional parameters are fully documented in the schema. For a read-only list tool with zero required parameters this is close to complete; only usage routing is missing.

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%, with site, fields, and search each documented in the schema itself, so the baseline of 3 applies. The description's field enumeration loosely hints at what can be projected via the 'fields' parameter but adds no syntax or selection semantics beyond the schema.

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?

The description states a specific verb and resource ('List WAN connections') and then enumerates the WAN-specific attributes returned (connection type, VLAN, PPPoE user, DNS, failover, ISP speeds, live health), which makes it clearly distinct from generic siblings like unifi_list_networks or unifi_list_devices. It stops short of explicitly naming a sibling it should not be confused with.

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?

There is no explicit when-to-use, when-not-to-use, or alternative routing guidance; the agent must infer that this tool is for inspecting WAN uplinks versus LAN networks. For a simple read-only list tool the implied usage is fairly self-evident, so this is adequate but with a clear gap.

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