Skip to main content
Glama

unifi_gen_getvpnserverpage

unifi_gen_getvpnserverpage
Read-onlyIdempotent

Lists VPN servers from UniFi with filtering and pagination support, so you can retrieve available VPN server pages by limit, offset, and filter criteria.

Instructions

List VPN Servers - generated from developer.ui.com/network/v11.0.97/getvpnserverpage

Input Schema

NameRequiredDescriptionDefault
limitNo
filterNo
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already declare readOnly, idempotent, openWorld, and non-destructive, so the safety profile is covered. The description adds nothing beyond that: it doesn't explain pagination behavior despite limit/offset params, nor result ordering or filtering scope. 'Generated from <url>' is provenance metadata, not behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

A single short sentence with no padding, but it is under-specified rather than efficient, and the trailing spec URL consumes space without adding actionable meaning.

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

Completeness3/5

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

No output schema exists, so the description should convey something about the returned collection and pagination, which it does not. For a simple read-only list endpoint the annotations plus schema names are nearly sufficient, but the filter and paging semantics remain undocumented.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% on all three parameters, so the description carries the full burden and fails to compensate. It says nothing about the filter syntax, default/max page size, or how offset interacts with limit, all of which an agent would need to paginate correctly.

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'), which is clear enough to act on. However, a near-identical sibling exists (unifi_net_list_vpn_servers), and the description makes no attempt to distinguish the two, leaving an agent to guess which is canonical.

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

Usage Guidelines2/5

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

No guidance on when to use this versus the sibling vpn-server listing tools or the site-to-site VPN tool. There are no exclusions, prerequisites, or context cues at all.

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

Deploy Server

Other Tools