Skip to main content
Glama
owine

UniFi Network MCP Server

by owine

List networks

unifi_list_networks
Read-only

List all VLANs and LAN segments at a UniFi site to inventory networks, including IDs, names, VLAN IDs, zones, and enabled status. Use filters to narrow results by VLAN.

Instructions

List all networks (VLANs/LAN segments) at a site. Returns: id, name, management (UNMANAGED/GATEWAY/SWITCH), enabled, vlanId, default (true for the default network), zoneId (the firewall zone the network sits in), dhcpGuarding (only present when enabled), metadata.origin (+ metadata.configurable on the system-defined default network). NOTE: the list view is sparse — for subnet/DHCP/NTP detail (ipv4Configuration/ipv6Configuration), call unifi_get_network on a specific id. Use for: VLAN inventory; pair with unifi_get_network_references to find what consumes a network.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of records to return (API default: 25)
filterNoFilter expression, e.g. vlanId.eq(20)
offsetNoNumber of records to skip
siteIdYesSite ID

Output Schema

NameRequiredDescriptionDefault
dataYes
countNo
limitNo
offsetNo
totalCountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.15.0
    • changedInput schema / properties / filter / description
      Previous value: -"Filter expression"New value: +"Filter expression, e.g. vlanId.eq(20)"
    • 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"
      +}
  2. Changed2 schema fields changedv2.13.0
    • changedInput schema / properties / limit / minimum
      Previous value: -1New value: +0
    • addedOutput schema / properties / data / items / properties / ipv6Configuration
      Added value: +{}
  3. First observedv2.8.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds genuine behavioral context beyond that: the list view is explicitly 'sparse', dhcpGuarding is 'only present when enabled', and metadata.configurable appears only on the system-defined default network. It does not mention pagination behavior (limit/offset interplay), which keeps it from 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and scoping, then enumerates the return fields in a compact clause-run. It is information-dense rather than padded, though the long comma-separated field list and the trailing NOTE make it slightly dense to scan.

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?

Even though an output schema exists, the description usefully documents the actual returned fields and their conditional presence, and it routes the agent to unifi_get_network for detail the list omits. For a 4-parameter read tool with no destructive behavior, nothing an agent needs to call 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% — limit, filter, offset and siteId are all documented in the schema itself, including the API default of 25 and a filter expression example. The description adds no parameter detail, so the baseline 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 all networks (VLANs/LAN segments) at a site') and immediately distinguishes itself from the sibling unifi_get_network by scoping itself to the sparse list view. An agent can tell what this returns and how it differs from the get-by-id tool 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 Guidelines5/5

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

Explicit routing: 'for subnet/DHCP/NTP detail ... call unifi_get_network on a specific id' names the alternative and the condition that selects it, and 'pair with unifi_get_network_references to find what consumes a network' gives a second concrete use. The 'Use for: VLAN inventory' clause adds a positive trigger.

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