Skip to main content
Glama

List VPNs

unifi_list_vpns
Read-only

List UniFi gateway VPN servers, clients, and site-to-site tunnels with configuration details such as kind, enabled state, subnet, port, WAN interface, peers, remote subnets, and DNS.

Instructions

List the gateway's VPN servers (WireGuard, OpenVPN, L2TP), VPN clients and site-to-site VPNs with kind, enabled state, subnet, port, WAN interface, peer and remote subnets and DNS. raw: true shows every field.

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

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.6/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 the safety profile is covered. The description adds the meaningful point that results carry kind, enabled state, subnet, port, WAN interface, peer, remote subnets and DNS, and notes that raw returns every field — useful in the absence of an output schema. It says nothing about result volume, pagination, or whether disabled VPNs are included.

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?

Two sentences, front-loaded with what is listed and what comes back, with the raw escape hatch last. No filler or restated title text.

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 no output schema, describing the returned field set is the right compensation and it is done here. The remaining gap is operational detail — result size, whether all VPN kinds are always returned together, and any pagination — but nothing an agent needs in order to invoke it correctly 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%, so all four parameters (raw, site, fields, search) are already documented in the schema; the baseline is 3. The description adds only the one gloss on raw: true ("shows every field") and says nothing about how site, fields, or search interact with the returned VPN kinds.

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 and resource ("List the gateway's VPN servers") and enumerates exactly what kinds are covered: WireGuard, OpenVPN, L2TP servers, VPN clients, and site-to-site VPNs. That boundary is precise enough that an agent knows whether a request for 'wireguard peers' or 'site-to-site tunnels' belongs here, though it never names a sibling for contrast.

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 or when-not-to-use guidance, and no alternative tool is named (e.g. whether unifi_list_networks or unifi_list_clients is better for a subnet question). The enumeration of VPN categories implicitly defines scope, which is enough to infer usage but not to route decisively between near-neighbours.

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