Skip to main content
Glama

Get security settings

unifi_get_security_settings
Read-only

Retrieve UniFi threat management, DPI traffic identification, and geo-IP blocking settings for a site, with optional listing of supported IPS categories.

Instructions

Get threat management (IDS/IPS mode, categories, protected networks), traffic identification (DPI) and country/region blocking (geo-IP) settings. Optionally list the IPS categories the controller supports (Network 8+).

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

Input Schema

NameRequiredDescriptionDefault
siteNoSite name/ID as used in the API (e.g. 'default'). Defaults to the configured site. See unifi_list_sites.
include_categoriesNoAlso fetch the catalog of available IPS categories (v2 API, Network 8+)

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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 covered. The description adds genuinely useful context beyond that: the version dependency ('Network 8+') for the category catalog and the fact that the optional flag triggers an extra v2 API call. It does not describe return shape, but with annotations carrying the safety profile this is solid.

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 dense sentence that front-loads the main purpose and appends the optional behavior last. Every clause names a distinct setting domain; nothing is wasted.

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 read-only getter with no output schema, the description adequately conveys what configuration is returned and the one version caveat. It could say more about the response structure, but the enumeration of covered domains is sufficient for correct invocation.

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 coverage is 100%, so both parameters are already documented in the schema, including the 'Network 8+' note on include_categories. The description restates the optional category listing but adds no syntax or format detail beyond the schema, 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 ('Get security settings') and then enumerates the exact sub-domains covered: threat management (IDS/IPS mode, categories, protected networks), DPI traffic identification, and geo-IP blocking. This clearly separates it from siblings like unifi_get_dpi_stats (statistics) or unifi_list_content_filters (filter lists).

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?

The description implies usage (read current security configuration) and notes the optional category-catalog fetch, but gives no explicit when-to-use/when-not guidance or routing to alternatives. An agent can infer the context but must decide on its own when this is the right call versus other settings getters.

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