UniFi Network MCP Server

Overview Schema Source Related Servers Discussions Admin

List VPN servers

unifi_list_vpn_servers

Read-only

List VPN servers at a UniFi site to inspect roaming or client-access VPN configurations, including type, name, and enabled status.

Instructions

List VPN servers (roaming/client-access VPNs) at a site. Returns: id, type (L2TP, OPENVPN, PPTP, UID, WIREGUARD), name, enabled, metadata.origin.

Input Schema

Name	Required	Description
`limit`	No	Number of records to return (API default: 25)
`filter`	No	Filter expression, e.g. type.eq('WIREGUARD')
`offset`	No	Number of records to skip
`siteId`	Yes	Site ID

Output Schema

Name	Required	Description	Default
`data`	Yes
`count`	No
`limit`	No
`offset`	No
`totalCount`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv2.15.0Oct 14, 2026

changedInput schema / properties / filter / description

Previous value: -"Filter expression"New value: +"Filter expression, e.g. type.eq('WIREGUARD')"

changedInput schema / properties / limit / description

Previous value: -"Number of records to return (default: 25, max: 200)"New value: +"Number of records to return (API default: 25)"

changedInput schema / properties / offset / description

Previous value: -"Number of records to skip (default: 0)"New value: +"Number of records to skip"

addedInput schema / properties / siteId / pattern
```
Added value: +"^[A-Za-z0-9_-]{1,64}$"
```
changedOutput schema / additionalProperties
```
Previous value: -falseNew value: +{}
```
addedOutput schema / properties / data / items / properties / metadata / properties / configurable
```
Added value: +{
+  "type": "boolean"
+}
```

Changed1 schema field changedv2.13.0Sep 20, 2026
- changedInput schema / properties / limit / minimum
```
Previous value: -1New value: +0
```
First observedv2.8.0Jun 30, 2026

TDQS

A3.5/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds the returned fields and the type enumeration, but no auth, pagination, or filtering behavior beyond that; an output schema exists, so the return list is largely redundant.

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 efficient sentences, purpose front-loaded ahead of the return details. No wasted text, though the return enumeration borders on redundant given the 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?

For a read-only list tool with full schema coverage, an output schema, and safety annotations, the definition is nearly complete. It could mention the filter capability (type.eq) and pagination, but those live in the schema.

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 limit, filter, offset, and siteId are already documented in the schema (including the filter example and API default). The description adds nothing beyond 'at a site', so baseline 3 applies.

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 VPN servers') with a scoping clarifier ('roaming/client-access VPNs) at a site'). The parenthetical helps distinguish it from the adjacent unifi_list_vpn_tunnels sibling, though it does not name that sibling explicitly.

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?

The 'at a site' phrasing implies the required context, but there is no explicit when-to-use/when-not guidance and no routing to unifi_list_vpn_tunnels versus this tool. Usage is only implied.

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

Deploy Server