OPNsense MCP Server

Name: OPNsense MCP Server
Author: Richard Stovall

Richard Stovall

Get started Repository

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

Setup

Choose your client, copy the config, then fill in any required environment variables.

Add to Cursor Add to VS Code

claude mcp add opnsense --env OPNSENSE_URL='<OPNSENSE_URL>' --env OPNSENSE_API_KEY='<OPNSENSE_API_KEY>' --env OPNSENSE_API_SECRET='<OPNSENSE_API_SECRET>' -- npx -y @richard-stovall/opnsense-mcp-server

~/.codex/config.toml

[mcp_servers.opnsense]
command = "npx"
args = ["-y", "@richard-stovall/opnsense-mcp-server"]
env = { OPNSENSE_URL = "<OPNSENSE_URL>", OPNSENSE_API_KEY = "<OPNSENSE_API_KEY>", OPNSENSE_API_SECRET = "<OPNSENSE_API_SECRET>" }

# codex mcp add opnsense --env OPNSENSE_URL='<OPNSENSE_URL>' --env OPNSENSE_API_KEY='<OPNSENSE_API_KEY>' --env OPNSENSE_API_SECRET='<OPNSENSE_API_SECRET>' -- npx -y @richard-stovall/opnsense-mcp-server

~/.cursor/mcp.json

{
  "mcpServers": {
    "opnsense": {
      "command": "npx",
      "args": [
        "-y",
        "@richard-stovall/opnsense-mcp-server"
      ],
      "env": {
        "OPNSENSE_URL": "<OPNSENSE_URL>",
        "OPNSENSE_API_KEY": "<OPNSENSE_API_KEY>",
        "OPNSENSE_API_SECRET": "<OPNSENSE_API_SECRET>"
      }
    }
  }
}

.vscode/mcp.json

{
  "servers": {
    "opnsense": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@richard-stovall/opnsense-mcp-server"
      ],
      "env": {
        "OPNSENSE_URL": "<OPNSENSE_URL>",
        "OPNSENSE_API_KEY": "<OPNSENSE_API_KEY>",
        "OPNSENSE_API_SECRET": "<OPNSENSE_API_SECRET>"
      }
    }
  }
}

~/.gemini/settings.json

{
  "mcpServers": {
    "opnsense": {
      "command": "npx",
      "args": [
        "-y",
        "@richard-stovall/opnsense-mcp-server"
      ],
      "env": {
        "OPNSENSE_URL": "<OPNSENSE_URL>",
        "OPNSENSE_API_KEY": "<OPNSENSE_API_KEY>",
        "OPNSENSE_API_SECRET": "<OPNSENSE_API_SECRET>"
      }
    }
  }
}

claude_desktop_config.json

{
  "mcpServers": {
    "opnsense": {
      "command": "npx",
      "args": [
        "-y",
        "@richard-stovall/opnsense-mcp-server"
      ],
      "env": {
        "OPNSENSE_URL": "<OPNSENSE_URL>",
        "OPNSENSE_API_KEY": "<OPNSENSE_API_KEY>",
        "OPNSENSE_API_SECRET": "<OPNSENSE_API_SECRET>"
      }
    }
  }
}

.trae/mcp.json

{
  "mcpServers": {
    "opnsense": {
      "command": "npx",
      "args": [
        "-y",
        "@richard-stovall/opnsense-mcp-server"
      ],
      "env": {
        "OPNSENSE_URL": "<OPNSENSE_URL>",
        "OPNSENSE_API_KEY": "<OPNSENSE_API_KEY>",
        "OPNSENSE_API_SECRET": "<OPNSENSE_API_SECRET>"
      }
    }
  }
}

Environment variables

OPNSENSE_URL
OPNSENSE_API_KEY
OPNSENSE_API_SECRET

Replace the placeholders with your own credentials and keep them out of version control.

Setup

Environment variables

Related