Skip to main content
Glama

List object-oriented network policies

unifi_list_oon_policies
Read-only

List UniFi object-oriented networking policies to inspect client or client-group rules for scheduling or blocking internet/app access, limiting bandwidth, or routing traffic through a VPN.

Instructions

List object-oriented networking (OON) policies: rules attached to clients or client groups that schedule or block internet access and apps (secure), limit bandwidth (qos) or route through a VPN (route). Needs Network 9.4+ with a UniFi gateway.

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_oon_policies"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full controller objects (large)
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

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and idempotentHint=false, so the safety profile is covered structurally. The description contributes the version and gateway requirement, which is genuinely useful context. It says nothing about result size, pagination, or what the policy objects contain, but the schema covers the 'raw' expansion behavior.

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, both loaded with information: the first defines the resource and its three policy categories, the second gives the hard prerequisite. No filler, no restatement of the title, prerequisite placed at the end where it reads as a gate.

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?

A filtered list tool with full schema coverage and no output schema needs modest description, and this supplies the domain definition plus a compatibility gate. The one gap is that it does not clarify how OON policies relate to the adjacent qos/firewall rule tools an agent may also see.

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%, with all four parameters (raw, site, fields, search) documented in the schema itself, including examples and defaults. The description adds no parameter 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?

States a specific verb and resource ('List object-oriented networking (OON) policies') and then defines what an OON policy is: rules attached to clients or client groups for secure/qos/route purposes. That is well beyond a restated title. It stops short of naming how it differs from siblings like unifi_list_firewall_policies or unifi_list_qos_rules, so an agent could still hesitate between them.

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?

Includes a real usage prerequisite ('Needs Network 9.4+ with a UniFi gateway'), which is actionable. However, it gives no when-to-use guidance relative to alternatives and no exclusions, even though the secure/qos/route categories overlap conceptually with unifi_list_qos_rules and unifi_list_firewall_policies.

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