How do I install the opnsensemcp mcp server?

Use a recorded configuration for your client, replace example credential values and paths, and verify the documented runtime. Restart or reconnect the client, then inspect the available tools.

What credentials does it need?

It reads `OPNSENSE_HOST`, `OPNSENSE_API_KEY`, `OPNSENSE_API_SECRET`, `OPNSENSE_VERIFY_SSL`, `OPNSENSE_SSH_HOST`, `OPNSENSE_SSH_KEY_PATH` from the environment. Store these in your client's env block or a secrets manager — never commit them to a repository — and grant the narrowest scope that still covers your use case.

SSyncDev

Start a project

OPNSenseMCP MCP Server

Model Context Protocol server for OPNSense firewall management with inter-VLAN routing diagnostics, ARP table, DNS filtering and HAProxy support via

Local serverstdio

What is the OPNSenseMCP MCP Server?

Model Context Protocol server for OPNSense firewall management with inter-VLAN routing diagnostics, ARP table, DNS filtering and HAProxy support via Claude Desktop

What it actually does

A Model Context Protocol (MCP) server for comprehensive OPNsense firewall management. This server enables AI assistants like Claude to directly manage firewall configurations, diagnose network issues, and automate complex networking tasks.

Configuration

Node.js 18+ or Bun 1.0+ - OPNsense firewall (v24.7+ recommended) - API credentials for OPNsense - SSH access (optional, for advanced features)

More MCP options

Compare MCP servers by category, or browse hosted MCP servers if you prefer an endpoint over a local process.

Maintainer setup documentation.

Recorded tools

Check the linked publisher documentation and your connected client's tool list. Names and availability can vary with the server version and account permissions.

Tool	What it does
firewall_list_rules	List all firewall rules
firewall_create_rule	Create a new rule
firewall_update_rule	Update existing rule
firewall_delete_rule	Delete a rule
firewall_apply_changes	Apply pending changes
nat_list_outbound	List outbound NAT rules
nat_set_mode	Set NAT mode
nat_create_outbound_rule	Create NAT rule
nat_fix_dmz	Fix DMZ NAT issues
nat_analyze_config	Analyze NAT configuration
arp_list	List ARP table entries
routing_diagnostics	Diagnose routing issues
routing_fix_all	Auto-fix routing problems
interface_list	List network interfaces
vlan_create	Create VLAN
system_execute_command	Execute CLI command
backup_create	Create configuration backup
service_restart	Restart a service

How to install the OPNSenseMCP MCP Server

{
  "mcpServers": {
    "opnsense": {
      "command": "bun",
      "args": [
        "run",
        "/path/to/OPNSenseMCP/src/index.ts"
      ],
      "env": {
        "OPNSENSE_HOST": "https://your-opnsense:port",
        "OPNSENSE_API_KEY": "YOUR_OPNSENSE_API_KEY",
        "OPNSENSE_API_SECRET": "YOUR_OPNSENSE_API_SECRET",
        "OPNSENSE_VERIFY_SSL": "false"
      }
    }
  }
}

From the project documentation. Replace placeholders and example paths before connecting.

Configuration

Node.js 18+ or Bun 1.0+ - OPNsense firewall (v24.7+ recommended) - API credentials for OPNsense - SSH access (optional, for advanced features)

Variable	Description	Required
OPNSENSE_HOST	Declared in the maintainer’s client configuration.	Check documentation
OPNSENSE_API_KEY	Declared in the maintainer’s client configuration.	Check documentation
OPNSENSE_API_SECRET	Declared in the maintainer’s client configuration.	Check documentation
OPNSENSE_VERIFY_SSL	Declared in the maintainer’s client configuration.	Check documentation

Example prompts to try

“Use OPNSenseMCP to firewall list rules.”
“Use OPNSenseMCP to firewall create rule.”
“Use OPNSenseMCP to firewall update rule.”

Frequently asked questions

Model Context Protocol server for OPNSense firewall management with inter-VLAN routing diagnostics, ARP table, DNS filtering and HAProxy support via Claude Desktop Confirm the tools offered by your installed version in the connected client. Tool availability and permissions depend on the server and account configuration.