Skip to main content
Glama

get_firewall_group

Retrieve a specific firewall group by its ID from a UniFi site, using the host and site identifiers to return its configuration.

Instructions

Get a single firewall group by ID.

host: console name, ID, or composite ID (MAC:numericId format). site: site name or ID. group_id: firewall group ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostYes
siteYes
group_idYes
Install Server

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden of behavioral disclosure. It clearly indicates a read-only fetch and explains accepted identifier formats, which is useful. It does not disclose possible error cases, response shape, or whether the group includes nested rules, but for a simple getter this is acceptable though not exhaustive.

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?

The main purpose is front-loaded in the first sentence, followed by terse parameter clarifications. There is no redundant wording, filler, or repetition of schema information.

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 getter with no output schema, the description covers the core action and all parameter meanings. It could additionally state what the response contains or that a missing group returns an error, but the current information is sufficient for an agent to call the tool correctly in most situations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema provides only bare string types with 0% description coverage. The description compensates fully by explaining host as 'console name, ID, or composite ID (MAC:numericId format)', site as 'site name or ID', and group_id as 'firewall group ID'. All three parameters are given meaningful semantics.

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?

The description states a specific verb ('Get'), a specific resource ('a single firewall group'), and the retrieval key ('by ID'). The word 'single' clearly distinguishes it from the sibling 'list_firewall_groups' without requiring schema inspection.

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 usage context is implied: if you know a firewall group's ID, call this tool. However, it does not explicitly say to use list_firewall_groups first to discover group IDs, nor does it mention when not to use this tool. The guidance is present but not explicit about alternatives.

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

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/swkstudios/unifi-fabric-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server