Skip to main content
Glama
lucamarien

OPNsense MCP Server

by lucamarien

opn_list_nat_rules

List NAT port forwarding rules to view forwarded ports, check configurations, and troubleshoot DNAT issues.

Instructions

List NAT port forwarding (DNAT) rules.

Use this when you need to see which ports are forwarded to internal hosts, check NAT rule configuration, or troubleshoot port forwarding issues.

Like firewall filter rules, this only returns MVC-managed NAT rules. Legacy NAT rules from the traditional GUI may not appear here — use opn_get_config_section('nat') to see all NAT configuration.

Returns: dict with 'rows' (list of NAT rules) and 'rowCount' (total).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
searchNo
limitNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

No annotations provided, but description fully discloses that only MVC-managed NAT rules are returned, not legacy ones. It also describes return format (dict with 'rows' and 'rowCount'). No contradictions.

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 concise, front-loaded with purpose, and each sentence adds value. 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?

Covers scope, return format, and provides alternative for legacy rules. Missing parameter semantics reduces completeness slightly, but output schema exists and overall information is sufficient for most use cases.

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 0%, yet description does not explain the parameters 'search' or 'limit'. It does not add meaning beyond the schema's type and default values. This is a significant gap for effective use.

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 it lists NAT port forwarding (DNAT) rules, using specific verb and resource. It distinguishes from sibling opn_get_config_section('nat') which returns all NAT configuration including legacy rules.

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

Usage Guidelines5/5

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

Explicitly states when to use (seeing forwarded ports, checking config, troubleshooting) and when not to use (legacy rules not shown), providing alternative opn_get_config_section('nat').

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