Skip to main content
Glama
Sign In
UniFi MCP Server

UniFi MCP Server

by enuno
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

suspend_carrier_subscriber

Suspend a UniFi Carrier Fabric subscriber by ID, with optional reason, dry-run preview, and confirmation controls.

Instructions

Suspend a UniFi Carrier Fabric subscriber.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "subscriber_id": "<subscriber_id>"
    },
    "name": "suspend_carrier_subscriber"
  }
}

Input Schema

NameRequiredDescriptionDefault
reasonNoOptional suspension reason
confirmNoMust be true to apply the change (required unless dry_run)
dry_runNoPreview the change without applying it
controllerNoController to run against (see list_controllers). Defaults to the controller chosen with select_controller, then the server default.
subscriber_idYesSubscriber identifier

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.6.4
    • addedInput schema / properties / confirm / description
      Added value: +"Must be true to apply the change (required unless dry_run)"
    • addedInput schema / properties / dry_run / description
      Added value: +"Preview the change without applying it"
    • addedInput schema / properties / reason / description
      Added value: +"Optional suspension reason"
    • addedInput schema / properties / subscriber_id / description
      Added value: +"Subscriber identifier"
  2. Addedv0.6.1

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full burden but only implies a state-changing operation. It says nothing about the confirm requirement, dry_run preview path, whether suspension is reversible, what permissions are needed, or what state the subscriber enters.

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?

A single front-loaded sentence with no padding. It is efficiently sized, though its brevity is closer to under-specification than true crispness.

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?

An output schema and fully documented parameters cover the mechanical call details, but for a destructive state change with no annotations the description should at least signal the confirm/dry_run safety flow or reversibility. It leaves the agent to discover that behavior from the schema alone.

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%, and the schema documents subscriber_id, reason, confirm, dry_run, and controller resolution order. The description adds no meaning beyond that, so the 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?

The description names a specific verb ('Suspend') and resource ('UniFi Carrier Fabric subscriber'), which lets an agent distinguish it from siblings like resume_carrier_subscriber and create_carrier_subscriber without opening the schema. It stops short of any explicit sibling differentiation or scope statement.

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 guidance on when to use this tool versus alternatives such as resume_carrier_subscriber or update_carrier_subscriber, and no prerequisites or preconditions are stated. The agent must infer usage entirely from the verb.

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