Skip to main content
Glama
lucamarien

OPNsense MCP Server

by lucamarien

opn_delete_nat_rule

Delete a NAT port forwarding rule by UUID; changes auto-revert in 60 seconds unless confirmed with opn_confirm_changes.

Instructions

Delete a NAT port forwarding rule by UUID with savepoint protection.

Use this when you need to remove an existing NAT rule. Changes auto-revert in 60 seconds unless confirmed with opn_confirm_changes. Use opn_list_nat_rules first to find the UUID of the rule to delete. Returns: dict with 'revision' (str) for confirming and 'result' (str).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Since no annotations are provided, the description fully carries the burden. It discloses savepoint protection and auto-revert in 60 seconds unless confirmed via opn_confirm_changes, and mentions the return dict format. This is good additional behavioral context.

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?

Description is extremely concise: 4 sentences, each serving a purpose. It front-loads the primary action and then adds usage guidance, behavioral note, and return info. No wasted words.

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?

Given the tool's simplicity (1 param, sibling tools provided), the description covers purpose, usage, behavior, and return structure. It lacks only details on error handling or permissions, but overall is very complete for a delete operation.

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 has 0% description coverage, so description must compensate. It explains that the UUID should be obtained via opn_list_nat_rules, adding meaningful context. However, it does not specify the expected format of the UUID, which would be helpful.

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?

Description clearly states 'Delete a NAT port forwarding rule by UUID with savepoint protection.' It uses specific verb (Delete) and resource (NAT rule), and distinguishes from siblings like opn_add_nat_rule and opn_update_nat_rule.

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?

Description explicitly says 'Use this when you need to remove an existing NAT rule' and advises to 'Use opn_list_nat_rules first to find the UUID.' It provides clear context but does not mention when not to use or alternative tools for modification.

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

Install Server

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/lucamarien/opnsense-mcp-server'

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