Skip to main content
Glama

unifi_gen_patchfirewallpolicy

unifi_gen_patchfirewallpolicy
DestructiveIdempotent

Updates an existing UniFi firewall policy by ID, with optional dry-run preview and a confirmation flag to apply changes safely.

Instructions

Patch Firewall Policy - generated from developer.ui.com/network/v11.0.97/patchfirewallpolicy

Input Schema

NameRequiredDescriptionDefault
bodyNoJSON request body, sent as is. Top-level vendor fields only; full schema: vendor docs page in the description. The API requires a body.
confirmNo"YES" to apply; without it the tool returns a preview.
dry_runNotrue: preview only, nothing is sent.
firewallPolicyIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is covered. The description adds nothing beyond a docs link: it does not say what the patch semantics are, what happens to unmentioned fields, or that the operation is destructive to existing policy configuration. It is consistent with the annotations, just not additive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The single line is front-loaded with verb and resource and contains no filler sentences. The vendor-URL suffix is mildly useful provenance but does not compensate for how little operational content is packed in.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, open-world mutation with four parameters and no output schema, the description should explain patch semantics and the confirm/dry_run workflow. Instead it is one boilerplate line plus a URL, leaving an agent to infer everything from the schema.

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

Parameters2/5

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

Schema description coverage is 75%, just under the baseline where the schema alone is considered sufficient, and the description contributes zero parameter information. The required firewallPolicyId carries only a format/pattern and no prose meaning, and the preview-vs-apply semantics of confirm/dry_run live entirely in the schema rather than the description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Patch) and resource (Firewall Policy), so the basic operation is identifiable. However, it does not distinguish this from the near-identical siblings unifi_net_patch_firewall_policy and unifi_gen_updatefirewallpolicy, and 'Patch' is never explained (partial update of which fields?). The purpose is recognizable but under-differentiated.

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

Usage Guidelines2/5

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

There is no guidance on when to use this versus unifi_gen_updatefirewallpolicy (full update) or the unifi_net_* variant of the same operation. The only added context is a vendor documentation URL, which is a reference, not a usage rule.

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

Deploy Server

Other Tools