Opnsense MCP Server

Modular MCP server for OPNsense firewall management - 88 tools providing access to 2000+ methods

Local serverstdioTypeScript

What is the Opnsense MCP Server?

Opnsense becomes available to MCP clients through the opnsense mcp server. Modular MCP server for OPNsense firewall management - 88 tools providing access to 2000+ methods.

What Opnsense does

A modular Model Context Protocol (MCP) server that provides 88 module-based tools giving access to over 2000 OPNsense firewall management methods through a type-safe TypeScript interface.

Key capabilities

  • Modular Architecture — - 88 logical tools (one per module) instead of 2000+ individual tools
  • Complete API Coverage — - Access to 752 core methods and 1271 plugin methods
  • Type-Safe — - Full TypeScript support with @richard-stovall/opnsense-typescript-client v0.5.3
  • Plugin Support — - Optional support for 64 plugin modules
  • Smart Organization — - Related operations grouped by module for easier discovery

Requirements

  • Node.js 18 or higher - An OPNsense firewall with API access enabled - API key and secret from your OPNsense installation

Practical notes

  • Maintained by Pixelworlds, written in TypeScript.

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.

ToolWhat it does
core_manageCore system functions
firewall_manageFirewall rules & aliases
interfaces_manageNetwork interfaces
diagnostics_manageSystem diagnostics
auth_manageAuthentication
firmware_manageFirmware updates
openvpn_manageOpenVPN
ipsec_manageIPsec VPN
wireguard_manageWireGuard VPN
unbound_manageDNS resolver
dhcpv4_manageDHCP server
plugin_nginx_manageNginx web server
plugin_haproxy_manageHAProxy load balancer

How to install the Opnsense MCP Server

{
  "mcpServers": {
    "opnsense": {
      "command": "npx",
      "args": [
        "-y",
        "@richard-stovall/opnsense-mcp-server"
      ],
      "env": {
        "OPNSENSE_URL": "https://192.168.1.1",
        "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 higher - An OPNsense firewall with API access enabled - API key and secret from your OPNsense installation
VariableDescriptionRequired
OPNSENSE_URLDeclared in the maintainer’s client configuration.Yes
OPNSENSE_API_KEYDeclared in the maintainer’s client configuration.Yes
OPNSENSE_API_SECRETDeclared in the maintainer’s client configuration.Yes
OPNSENSE_VERIFY_SSLDeclared in the maintainer’s client configuration.Check documentation

Example prompts to try

  • “Use Opnsense to Built.”
  • “Use Opnsense to core manage.”
  • “Use Opnsense to firewall manage.”

Frequently asked questions

Modular MCP server for OPNsense firewall management - 88 tools providing access to 2000+ methods Confirm the tools offered by your installed version in the connected client. Tool availability and permissions depend on the server and account configuration.