opnsense-mcp-server

Overview

This MCP server acts as a bridge between AI assistants and OPNsense firewalls, providing secure API access through a modular tool interface. With 88 logical tools (one per module) instead of 2000+ individual tools, it offers complete API coverage including 752 core methods and 1271 plugin methods. The server is built with TypeScript, uses the @richard-stovall/opnsense-typescript-client package for type safety, and supports both core and plugin modules.

Try asking AI

After installing, here are 5 things you can ask your AI assistant:

• core_manage

  Core system functions including backup, reboot, and firmware information

  Try:Use core_manage to check system statusTry:Perform a system backup using core_manage
• firewall_manage

  Firewall rules and aliases management

  Try:List all firewall aliases using firewall_manageTry:Add a new firewall rule with firewall_manage
• interfaces_manage

  Network interfaces configuration and management

  Try:Get information about all network interfaces using interfaces_manageTry:Configure a VLAN with interfaces_manage
• diagnostics_manage

  System diagnostics including ARP table and activity logs

  Try:View the ARP table using diagnostics_manageTry:Get system activity logs with diagnostics_manage
• auth_manage

  Authentication for users and groups

  Try:Search for users using auth_manageTry:Manage user groups with auth_manage
• firmware_manage

  Firmware update and management

  Try:Check for firmware updates using firmware_manageTry:Upgrade system firmware with firmware_manage
• openvpn_manage

  OpenVPN VPN instance management

  Try:List OpenVPN instances using openvpn_manageTry:Add a new OpenVPN instance with openvpn_manage
• ipsec_manage

  IPsec VPN tunnel and connection management

  Try:Search for IPsec tunnels using ipsec_manageTry:Check IPsec connection status with ipsec_manage
• wireguard_manage

  WireGuard VPN server and client management

  Try:List WireGuard servers using wireguard_manageTry:Manage WireGuard clients with wireguard_manage
• unbound_manage

  DNS resolver configuration and management

  Try:Search for host overrides using unbound_manageTry:Reconfigure the DNS service with unbound_manage
• dhcpv4_manage

  DHCP server configuration and lease management

  Try:Search for DHCP leases using dhcpv4_manageTry:Add a DHCP reservation with dhcpv4_manage
• plugin_nginx_manage

  Nginx web server configuration management

  Try:Get Nginx general configuration using plugin_nginx_manageTry:Search for Nginx upstreams with plugin_nginx_manage

Comparable tools

Installation

npm install -g @richard-stovall/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-api-key",
        "OPNSENSE_API_SECRET": "your-api-secret",
        "OPNSENSE_VERIFY_SSL": "false"
      }
    }
  }
}

FAQ

How do I enable plugin tools?

Add '--plugins' to the args or set 'INCLUDE_PLUGINS': 'true' in the environment variables.

What should I do if I encounter connection issues?

Verify your OPNsense API is enabled, check API key permissions, ensure IP/hostname accessibility, and consider using '--no-verify-ssl' for self-signed certificates.

Compare opnsense-mcp-server with