Skip to main content
Glama

List switch port profiles

unifi_list_port_profiles
Read-only

List UniFi switch port profiles to review reusable port settings such as forwarding mode, VLANs, PoE, speed, isolation, storm control, and port security.

Instructions

List switch port profiles (reusable port configurations): forwarding mode, native and tagged networks, PoE, speed, isolation, storm control and port security. unifi_list_switch_ports shows which profile each port uses.

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_port_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.2/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 covered. The description adds value beyond that by enumerating the attributes a profile carries, which functions as a lightweight return-shape disclosure in the absence of an output schema. Pagination or result-limit behavior is not mentioned, keeping it below 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.

Conciseness5/5

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

Two sentences, front-loaded with the verb and resource, then the disambiguation pointer to the sibling. No filler, no restatement of the title, and every clause carries information the agent needs.

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?

For a three-parameter, zero-required read-only list tool with a fully documented schema and no output schema, the definition covers identity, contents, and the key sibling relationship. Minor gaps around result volume or how profiles relate to sites are covered by the schema's site parameter, so nothing essential 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%, so site, fields, and search are already documented with examples in the schema. The description adds no parameter-level detail such as what fields are useful to project or how search matches profile names, 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 switch port profiles') and immediately disambiguates the resource with a parenthetical definition ('reusable port configurations'). It then enumerates the concrete contents (forwarding mode, native/tagged networks, PoE, speed, isolation, storm control, port security), so an agent knows exactly what this resource is before opening the schema.

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

Usage Guidelines4/5

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

The closing sentence routes the agent between this tool and the sibling unifi_list_switch_ports, explaining that the sibling shows which profile each port uses — a clear relational cue for choosing between them. It stops short of explicit when/when-not conditions or naming other profile-type list tools, but the context is unambiguous.

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