Skip to main content
Glama

List bandwidth profiles

unifi_list_bandwidth_profiles
Read-only

Lists bandwidth profiles with per-client download/upload caps in kbps (unlimited when uncapped) to inspect or select limits for WiFi networks and clients.

Instructions

List bandwidth profiles (user groups): per-client download and upload caps in kbps ("unlimited" when uncapped) that WiFi networks and clients can be assigned.

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is carried. The description adds real value beyond them by disclosing the data shape and units (kbps) and the sentinel value "unlimited" for uncapped entries, which the agent needs in order to interpret results correctly. It does not say whether results are paginated or complete, which keeps it out of the top band.

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: verb, resource, then the definition an agent needs. Every clause earns its place and nothing is repeated from the schema or annotations.

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?

Three optional parameters, no output schema, annotations present, so the description only needs to cover entity meaning, units, and sentinels, all of which it does. It stops short of describing result ordering or whether the listing is paginated, a small remaining gap for a list tool with zero required parameters.

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 site, fields, and search are all documented in the schema, including the pointer to unifi_list_sites and the dot-path format for fields. The description adds nothing parameter-specific, which is the expected baseline 3 when the schema does the work.

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 bandwidth profiles") and then defines the entity as "user groups" holding per-client download and upload caps, so an agent that has never seen UniFi terminology knows exactly what comes back. The parenthetical resolves the only ambiguity (profiles vs. port/radius profiles) without opening a sibling schema.

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?

Usage is only implied: it is a listing tool, so an agent can infer it is used to discover profiles or to look up a profile ID for later assignment. There is no explicit when-to-use framing, no statement that it is read-only discovery versus assignment, and no mention of the port-profile and radius-profile siblings that share the 'profiles' vocabulary.

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