Skip to main content
Glama
UniFi MCP Server

UniFi MCP Server

list_carrier_subscribers

Retrieve and filter UniFi Carrier Fabric subscribers by service plan, suspension status, and controller, with pagination support.

Instructions

List UniFi Carrier Fabric subscribers.

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": "list_carrier_subscribers"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of items to return
offsetNoNumber of items to skip
plan_idNoFilter by assigned service plan ID
suspendedNoFilter by suspended state
controllerNoController to run against (see list_controllers). Defaults to the controller chosen with select_controller, then the server default.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.6.4
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of items to return"
    • addedInput schema / properties / offset / description
      Added value: +"Number of items to skip"
    • addedInput schema / properties / plan_id / description
      Added value: +"Filter by assigned service plan ID"
    • addedInput schema / properties / suspended / description
      Added value: +"Filter by suspended state"
  2. Addedv0.6.1

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description must carry behavioral context alone. It only says the tool lists subscribers; it does not disclose pagination behavior, read-only nature, authentication requirements, or whether results span controllers.

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?

A single front-loaded sentence with no wasted words. It directly states the resource being listed.

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?

The schema is fully described and an output schema exists, covering most contract details. However, for a list operation with no annotations, the description does not clarify scope, such as whether it lists all subscribers or only those for a selected controller.

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, offset, plan_id, suspended, and controller are already documented in the schema. The description adds no parameter meaning beyond the schema baseline.

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: listing UniFi Carrier Fabric subscribers. It is clear what the tool returns, but it does not distinguish itself from siblings such as get_carrier_subscriber or list_carrier_service_plans.

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?

There is no explicit guidance on when to use this tool versus alternatives like get_carrier_subscriber for a single subscriber or list_carrier_service_plans for plans. The list action is implied, but no exclusions or selection criteria are provided.

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