Skip to main content
Glama

OPNsense MCP Server

by floriangrousset
GitHub
Python
AGPL 3.0
13
  • Apple
  • Linux
OverviewInspectNewEndpointsSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

🔥 OPNsense MCP Server

🚀 Transform your OPNsense firewall management with AI-powered natural language commands!

🎯 Quick Example: "Block all traffic from Russia and add those IPs to my threat list" → Done! ✅

OPNsense® is a powerful open-source firewall and routing platform built on FreeBSD. This project transforms traditional firewall management by enabling natural language control through AI clients like Claude Desktop. Simply speak to your firewall as you would to a network engineer, and watch complex configurations happen automatically!

🎉 What makes this special? Instead of clicking through web interfaces or memorizing API commands, just say:

  • "Show me what's using the most bandwidth" 📊
  • "Create a VPN user for my remote developer" 👥
  • "Block suspicious traffic and generate a security report" 🛡️

⚡ Quick Start (5 minutes)

# 1. 📥 Clone & Enter git clone https://github.com/floriangrousset/opnsense-mcp-server && cd opnsense-mcp-server # 2. 🛠️ Setup Environment curl -LsSf https://astral.sh/uv/install.sh | sh uv venv && source .venv/bin/activate uv pip install -r requirements.txt # 3. ⚙️ Configure Claude Desktop (Automatic!) ./setup-claude.sh # 🎉 Magic happens here! # 4. 🚀 Start Managing! # Open Claude Desktop and say: "Configure my OPNsense at 192.168.1.1"

🎊 That's it! You're now managing your firewall with natural language!

OPNsense MCP Server Logo

🧠 What is an MCP Server? Why Is It a Game Changer for AI?

The Model Context Protocol (MCP) is a new standard that lets AI models (like Claude, ChatGPT, and others) securely interact with real-world tools, data, and systems—not just answer questions, but actually take action. You can think of it as "giving hands to the brain": the AI is the brain, and the MCP server is the set of hands that can reach out and do things in the real world. For more technical details, refer to the official MCP specification.

🌟 Why is this revolutionary?

  • 🎯 From Answers to Actions: Traditional AI models only provide information. With MCP, they actually perform tasks—like managing your firewall, configuring VPNs, or analyzing security logs—by calling tools exposed by an MCP server.
  • 🔒 Security and Trust: MCP is designed to be secure and auditable. You control exactly what the AI can access, and you can see every action it takes.
  • 🔌 Plug-and-Play for AI Clients: Tools like Claude Desktop make it easy to connect to MCP servers. Just add the server in settings, and suddenly your AI can manage your OPNsense firewall!
  • 🎭 Separation of Concerns: The AI doesn't need to know OPNsense APIs. The MCP server handles all the technical details, so you get automation power without security risks.

🚀 How does it work in practice?

  1. 🏠 You run an MCP server (like this OPNsense MCP Server) on your machine or network
  2. 🔗 You connect your AI client (like Claude Desktop) to the MCP server in settings
  3. ⚡ The AI can now use the tools exposed by the server—securely, with your oversight

💡 The game changer: MCP servers let you safely delegate real-world network management tasks to AI, making your AI not just smart, but truly useful for infrastructure management!

🛠️ Complete Feature Set (110+ Tools!)

🔌 Connection & Configuration

ToolDescriptionExample Command
configure_opnsense_connectionSetup API connection"Connect to my OPNsense at 192.168.1.1"
get_api_endpointsList available endpoints"Show me all available API endpoints"

🖥️ System Management

ToolDescriptionExample Command
get_system_statusSystem overview & health"What's my firewall status?"
get_system_healthCPU, memory, disk metrics"Show system resource usage"
get_system_routesView routing table"Display the routing table"
restart_serviceControl system services"Restart the DHCP service"
backup_configExport configuration"Backup my firewall config"

🔥 Firewall Management

ToolDescriptionExample Command
firewall_get_rulesList all firewall rules"Show all firewall rules"
firewall_add_ruleCreate new firewall rule"Block port 445 from WAN"
firewall_delete_ruleRemove firewall rule"Delete rule abc123"
firewall_toggle_ruleEnable/disable rule"Disable the SSH access rule"
perform_firewall_auditComprehensive security audit"Audit my firewall security"

📝 Alias Management

ToolDescriptionExample Command
get_firewall_aliasesList all aliases"Show all firewall aliases"
add_to_aliasAdd IP/network to alias"Add 10.0.0.5 to BlockedIPs alias"
delete_from_aliasRemove from alias"Remove 10.0.0.5 from AllowedIPs"

🔄 NAT Management

ToolDescriptionExample Command
nat_list_outbound_rulesList outbound NAT rules"Show outbound NAT configuration"
nat_add_outbound_ruleCreate outbound NAT"Add outbound NAT for 10.0.0.0/24"
nat_delete_outbound_ruleRemove outbound NAT"Delete outbound NAT rule xyz"
nat_toggle_outbound_ruleEnable/disable NAT rule"Disable outbound NAT rule abc"
nat_list_one_to_one_rulesList 1:1 NAT mappings"Show one-to-one NAT rules"
nat_add_one_to_one_ruleCreate 1:1 NAT mapping"Map public IP to internal server"
nat_delete_one_to_one_ruleRemove 1:1 NAT"Delete 1:1 NAT mapping"
nat_get_port_forward_infoPort forwarding guidance"How do I setup port forwarding?"

🌐 Network Interface Management

ToolDescriptionExample Command
get_interfacesList all network interfaces"Show network interface status"
get_interface_detailsDetailed interface info"Get details for WAN interface"
reload_interfaceRestart network interface"Reload the LAN interface"
export_interface_configExport interface config"Export network configuration"

🔗 VLAN Management

ToolDescriptionExample Command
list_vlansList all VLANs"Show all VLAN interfaces"
get_vlanGet VLAN configuration"Get VLAN 100 settings"
create_vlan_interfaceCreate new VLAN"Create VLAN 200 on em0 interface"
update_vlanModify VLAN settings"Change VLAN 100 description"
delete_vlanRemove VLAN interface"Delete VLAN 200"
reconfigure_vlansApply VLAN changes"Apply all VLAN configuration changes"

🌉 Bridge Management

ToolDescriptionExample Command
list_bridgesList bridge interfaces"Show all network bridges"
get_bridgeBridge configuration details"Get bridge0 configuration"
create_bridgeCreate bridge interface"Create bridge between LAN1 and LAN2"
update_bridgeModify bridge settings"Update bridge spanning tree settings"
delete_bridgeRemove bridge interface"Delete bridge0 interface"
ToolDescriptionExample Command
list_lagg_interfacesList LAGG interfaces"Show link aggregation groups"
get_laggLAGG configuration details"Get lagg0 configuration"
create_laggCreate LAGG interface"Create LACP bond with em0 and em1"
update_laggModify LAGG settings"Change LAGG protocol to failover"
delete_laggRemove LAGG interface"Delete lagg0 interface"
reconfigure_laggApply LAGG changes"Apply LAGG configuration changes"

🏷️ Virtual IP Management

ToolDescriptionExample Command
list_virtual_ipsList virtual IP addresses"Show all virtual IPs"
get_virtual_ipVIP configuration details"Get virtual IP configuration"
create_virtual_ipCreate virtual IP"Add CARP VIP 10.0.0.100 on LAN"
update_virtual_ipModify VIP settings"Change virtual IP settings"
delete_virtual_ipRemove virtual IP"Delete virtual IP address"
get_next_carp_vhidGet available CARP ID"Find unused VHID for CARP setup"
reconfigure_virtual_ipsApply VIP changes"Apply virtual IP changes"

📡 DHCP Server Management

ToolDescriptionExample Command
dhcp_list_serversList DHCP server configs"Show DHCP server configurations"
dhcp_get_serverDHCP server details"Get LAN DHCP server settings"
dhcp_set_serverConfigure DHCP server"Setup DHCP for VLAN100 network"
dhcp_restart_serviceRestart DHCP service"Restart the DHCP service"
dhcp_get_leasesCurrent DHCP leases"Show active DHCP leases"
dhcp_search_leasesSearch for specific leases"Find lease for MAC aa"
dhcp_get_lease_statisticsDHCP usage statistics"Show DHCP usage statistics"

📍 DHCP Static Mappings

ToolDescriptionExample Command
dhcp_list_static_mappingsList DHCP reservations"Show DHCP static reservations"
dhcp_get_static_mappingGet reservation details"Get server DHCP reservation"
dhcp_add_static_mappingAdd DHCP reservation"Reserve 192.168.1.50 for printer"
dhcp_update_static_mappingUpdate reservation"Change printer IP reservation"
dhcp_delete_static_mappingDelete reservation"Remove printer DHCP reservation"

🔍 DNS Resolver (Unbound)

ToolDescriptionExample Command
dns_resolver_get_settingsDNS resolver configuration"Show DNS resolver settings"
dns_resolver_set_settingsConfigure DNS resolver"Enable DNSSEC validation"
dns_resolver_list_host_overridesList DNS host overrides"Show DNS host overrides"
dns_resolver_get_host_overrideGet host override details"Get override for server.local"
dns_resolver_add_host_overrideAdd DNS host override"Map server.local to 10.0.0.10"
dns_resolver_update_host_overrideUpdate host override"Change server.local IP address"
dns_resolver_delete_host_overrideDelete host override"Remove server.local override"
dns_resolver_list_domain_overridesList domain overrides"Show DNS domain forwarding"
dns_resolver_add_domain_overrideAdd domain override"Forward corp.com to 10.0.0.53"
dns_resolver_restart_serviceRestart DNS resolver"Restart DNS resolver service"

⏩ DNS Forwarder (dnsmasq)

ToolDescriptionExample Command
dns_forwarder_get_settingsDNS forwarder settings"Show DNS forwarder configuration"
dns_forwarder_set_settingsConfigure DNS forwarder"Enable DNS forwarder service"
dns_forwarder_list_hostsList forwarder hosts"Show DNS forwarder host entries"
dns_forwarder_add_hostAdd forwarder host entry"Add local.domain DNS entry"
dns_forwarder_restart_serviceRestart DNS forwarder"Restart DNS forwarder service"

🔐 Certificate Authority Management

ToolDescriptionExample Command
list_certificate_authoritiesList all CAs"Show Certificate Authorities"
get_certificate_authorityCA details"Get root CA information"
create_certificate_authorityCreate new CA"Create internal Certificate Authority"
delete_certificate_authorityRemove CA"Delete old Certificate Authority"
export_certificate_authorityExport CA certificate"Export CA certificate in PEM format"

📜 Certificate Management

ToolDescriptionExample Command
list_certificatesList all certificates"Show all SSL certificates"
get_certificateCertificate details"Get web server certificate details"
import_certificateImport certificate"Import SSL certificate and private key"
delete_certificateRemove certificate"Delete expired certificate"
export_certificateExport certificate"Export VPN certificate"

📋 Certificate Signing Requests

ToolDescriptionExample Command
list_certificate_signing_requestsList CSRs"Show pending certificate requests"
get_certificate_signing_requestCSR details"Get CSR information"
create_certificate_signing_requestGenerate CSR"Create CSR for domain.com"
delete_certificate_signing_requestRemove CSR"Delete certificate request"

🔄 ACME (Let's Encrypt) Management

ToolDescriptionExample Command
list_acme_accountsList ACME accounts"Show Let's Encrypt accounts"
get_acme_accountACME account details"Get ACME account information"
create_acme_accountCreate ACME account"Setup Let's Encrypt account"
delete_acme_accountRemove ACME account"Delete Let's Encrypt account"
list_acme_certificatesList ACME certificates"Show Let's Encrypt certificates"
get_acme_certificateACME certificate details"Get LE certificate details"
create_acme_certificateRequest ACME certificate"Get Let's Encrypt cert for domain.com"
sign_acme_certificateIssue certificate"Issue ACME certificate"
revoke_acme_certificateRevoke certificate"Revoke compromised certificate"
delete_acme_certificateRemove ACME certificate"Delete ACME certificate"

🔍 Certificate Analysis & Monitoring

ToolDescriptionExample Command
analyze_certificate_expirationCheck certificate expiry"Check certificate expiration status"
validate_certificate_chainValidate trust chain"Validate certificate trust chain"
get_certificate_usageCertificate usage info"Where is this certificate used?"

👥 User Management

ToolDescriptionExample Command
list_usersList all users"Show all system users"
get_userUser account details"Get admin user information"
create_userCreate new user"Add new administrator user"
update_userModify user settings"Update user permissions"
delete_userRemove user account"Delete inactive user account"
toggle_userEnable/disable user"Disable user account temporarily"
create_admin_userQuick admin creation"Create admin user quickly"
create_readonly_userCreate read-only user"Add monitoring-only user"
reset_user_passwordReset user password"Reset user password securely"
bulk_user_creationMass user creation"Import users from template"

👨‍👩‍👧‍👦 Group Management

ToolDescriptionExample Command
list_groupsList all groups"Show all user groups"
get_groupGroup details"Get administrators group info"
create_groupCreate user group"Create network operators group"
update_groupModify group settings"Update group description"
delete_groupRemove group"Delete empty user group"
add_user_to_groupAdd group member"Add user to administrators group"
remove_user_from_groupRemove group member"Remove user from operators group"
setup_user_group_templateCreate group template"Setup role-based group template"

🛡️ Privilege Management

ToolDescriptionExample Command
list_privilegesList available privileges"Show all available permissions"
get_user_effective_privilegesUser's actual privileges"What permissions does user have?"
assign_privilege_to_userGrant user privilege"Give user firewall management access"
revoke_privilege_from_userRemove user privilege"Remove admin rights from user"

🔑 Authentication Systems

ToolDescriptionExample Command
list_auth_serversList auth servers"Show LDAP/RADIUS servers"
test_user_authenticationTest user login"Test user authentication"

📊 Comprehensive Logging & Monitoring

ToolDescriptionExample Command
get_firewall_logsFirewall activity logs"Show last 100 blocked connections"
get_system_logsSystem event logs"Display system events from today"
get_service_logsService-specific logs"Show DHCP service logs"
search_logsSearch across all logs"Find failed login attempts"
export_logsExport logs to file"Export today's logs to JSON"
get_log_statisticsLog analysis & stats"Show 24-hour log analysis"
clear_logsClear old log files"Clear logs older than 30 days"
configure_loggingAdjust log settings"Set firewall logging to debug level"
analyze_security_eventsSecurity threat analysis"Analyze security events and threats"
generate_log_reportGenerate log reports"Create daily security report"

🔌 Plugin & Service Management

ToolDescriptionExample Command
list_pluginsList installed plugins"Show all installed plugins"
install_pluginInstall new plugin"Install WireGuard VPN plugin"

🌐 VPN Connection Monitoring

ToolDescriptionExample Command
get_vpn_connectionsVPN connection status"Show active VPN connections"

🚦 Traffic Shaping & QoS Management

ToolDescriptionExample Command
traffic_shaper_get_statusService status and statistics"Show traffic shaper status"
traffic_shaper_reconfigureApply QoS configuration changes"Apply traffic shaping changes"
traffic_shaper_get_settingsGeneral QoS configuration"Show traffic shaper settings"

🔧 Pipe Management (Bandwidth Limits)

ToolDescriptionExample Command
traffic_shaper_list_pipesList all bandwidth pipes"Show all traffic shaper pipes"
traffic_shaper_get_pipeGet pipe details"Get details for pipe abc123"
traffic_shaper_create_pipeCreate bandwidth limiting pipe"Create 100 Mbps pipe for guest network"
traffic_shaper_update_pipeModify pipe settings"Update pipe bandwidth to 50 Mbps"
traffic_shaper_delete_pipeRemove bandwidth pipe"Delete unused traffic pipe"
traffic_shaper_toggle_pipeEnable/disable pipe"Disable guest network pipe"

⚖️ Queue Management (Weighted Sharing)

ToolDescriptionExample Command
traffic_shaper_list_queuesList all traffic queues"Show all traffic shaper queues"
traffic_shaper_get_queueGet queue details"Get queue configuration for VoIP"
traffic_shaper_create_queueCreate weighted sharing queue"Create high-priority VoIP queue"
traffic_shaper_update_queueModify queue settings"Change queue weight to 80"
traffic_shaper_delete_queueRemove traffic queue"Delete old queue configuration"
traffic_shaper_toggle_queueEnable/disable queue"Enable gaming priority queue"

📋 Rule Management (Traffic Classification)

ToolDescriptionExample Command
traffic_shaper_list_rulesList all QoS rules"Show all traffic shaping rules"
traffic_shaper_get_ruleGet rule details"Get rule configuration"
traffic_shaper_create_ruleCreate traffic classification rule"Route gaming traffic to high-priority queue"
traffic_shaper_update_ruleModify rule settings"Update rule to target new queue"
traffic_shaper_delete_ruleRemove QoS rule"Delete obsolete traffic rule"
traffic_shaper_toggle_ruleEnable/disable rule"Enable VoIP priority rule"

🎯 Common QoS Use Cases (Helpers)

ToolDescriptionExample Command
traffic_shaper_limit_user_bandwidthPer-user bandwidth limiting"Limit user 192.168.1.50 to 10 Mbps"
traffic_shaper_prioritize_voipVoIP traffic prioritization"Setup VoIP priority with 5 Mbps guaranteed"
traffic_shaper_setup_gaming_priorityGaming traffic optimization"Optimize 100 Mbps connection for gaming"
traffic_shaper_create_guest_limitsGuest network bandwidth limits"Limit guest network to 20 Mbps total"

🔧 Advanced & Custom Tools

ToolDescriptionExample Command
exec_api_callExecute custom API calls"Execute GET on /api/custom/endpoint"

🎯 Total: 166 powerful tools for complete OPNsense management through natural language!

🌟 Real-World Success Stories

🏢 Enterprise Network Management

"We manage 50+ OPNsense firewalls across multiple sites. This MCP server lets our junior admins safely make changes using natural language, reducing configuration errors by 80% and training time by weeks!" - Network Operations Team

🚨 Incident Response

"During a security incident, I told Claude: 'Block all traffic from these suspicious IPs and create an audit report.' Done in 15 seconds instead of 5 minutes of clicking through interfaces!" - Security Engineer

📚 Learning & Training Tool

"Perfect for learning OPNsense! New team members can ask Claude to explain what each rule does before applying it. It's like having a network mentor available 24/7." - IT Training Manager

🏠 Home Lab Enthusiasts

"I can finally manage my home lab firewall properly without memorizing every interface. Just tell it what I want, and it handles the technical details!" - Home Lab Enthusiast

🎯 Try These Commands!

Perfect for getting started:

  • "Show me the firewall status and health"
  • "List all network interfaces and their status"
  • "What devices are currently connected via DHCP?"
  • "Show me recent firewall activity"
  • "Create a backup of my configuration"

For network administrators:

  • "Create a geo-blocking rule for all countries except USA and Canada"
  • "Setup a VLAN for IoT devices with restricted internet access"
  • "Analyze security logs and identify potential threats from the last 24 hours"
  • "Create DHCP reservations for all devices in the server VLAN"
  • "Generate SSL certificates for internal services using Let's Encrypt"

Advanced infrastructure management:

  • "Create a high-availability CARP setup with automatic failover between firewalls"
  • "Configure certificate-based VPN with automatic user provisioning and revocation"
  • "Implement zero-trust network segmentation for the DMZ with micro-segmentation rules"
  • "Setup automated threat response: block IPs with more than 10 failed attempts in 5 minutes"
  • "Create a comprehensive security audit report with compliance recommendations"

📋 Requirements

  • 🐍 Python 3.10+ (Modern Python environment)
  • 🔥 OPNsense Firewall with API access configured
  • 🤖 MCP-compatible client (Claude Desktop recommended)
  • 💾 Minimum 100MB disk space for installation

📦 Prerequisites

  • 🔧 git - For cloning the repository
  • ⚡ uv - Ultra-fast Python package manager (see installation below)
  • 🔨 jq - JSON processor (for automated Claude Desktop setup)

🚀 Installation Guide

Step 1: 📥 Clone the Repository

git clone https://github.com/floriangrousset/opnsense-mcp-server cd opnsense-mcp-server

Step 2: ⚡ Install uv (Ultra-Fast Python Manager)

uv is blazing fast and handles everything automatically:

# 🍎 macOS/Linux - One command install curl -LsSf https://astral.sh/uv/install.sh | sh # 🪟 Windows (PowerShell) curl -LsSf https://astral.sh/uv/install.ps1 | powershell -c -

Step 3: 🏠 Create Virtual Environment

# Create isolated Python environment uv venv # Activate it source .venv/bin/activate # 🐧 Linux/macOS # .venv\Scripts\activate # 🪟 Windows

Step 4: 📚 Install Dependencies

# Install all required packages (super fast with uv!) uv pip install -r requirements.txt

Step 5: 🔐 Make Scripts Executable (Linux/macOS only)

chmod +x opnsense-mcp-server.py setup-claude.sh

🎉 Installation Complete!

Time to configure your OPNsense connection...

🔐 Setup OPNsense API Access

📌 Important: Create dedicated API credentials for maximum security!

🔑 Step-by-Step API Setup:

  1. 🌐 Login to your OPNsense web interface
  2. 🧭 Navigate to System → Access → Users
  3. 👤 Select the user for API access (or create a dedicated mcp-server user)
  4. 🔑 Scroll down to the API keys section
  5. ➕ Click the + button to generate new API keys
  6. 📁 Download the API key file (contains your credentials)

💡 Pro Tip: Create a dedicated user with minimal required privileges instead of using admin credentials!

🤖 Configure Claude Desktop

Choose your preferred setup method:

The easiest way - one command does everything!

# Install jq if needed brew install jq # 🍎 macOS sudo apt install jq # 🐧 Ubuntu/Debian sudo yum install jq # 🎩 RHEL/CentOS # Run the magic setup script ./setup-claude.sh

🎊 That's it! The script automatically:

  • ✅ Finds your Claude Desktop config
  • ✅ Adds the MCP server entry
  • ✅ Creates proper file paths
  • ✅ Sets up everything perfectly

🔄 Restart Claude Desktop and you're ready to go!

🔧 Method 2: Manual Configuration

  1. 📥 Install Claude Desktop if you haven't already
  2. 🖥️ Open Claude Desktop
  3. ⚙️ Access settings from the Claude menu
  4. 🛠️ Go to the Developer tab
  5. 📝 Click "Edit Config"
  6. 🔧 Add this configuration (replace /path/to/ with your actual path):
{ "mcpServers": { "opnsense": { "command": "python", "args": [ "/FULL/PATH/TO/opnsense-mcp-server.py" ], "env": {} } } }
  1. 💾 Save the config file
  2. 🔄 Restart Claude Desktop

🎮 Usage Examples

Now the fun begins! Talk to your firewall like you're talking to a network engineer:

🔌 First Steps: Connect to Your Firewall

Configure my OPNsense firewall with the following information: URL: https://192.168.1.1 API Key: your_api_key API Secret: your_api_secret

📊 System Monitoring

What's the current status of my OPNsense firewall?
Show me system health - CPU, memory, and disk usage
What devices are currently getting DHCP leases?

🔥 Firewall Management

List all firewall rules and show me which ones are disabled
Create a rule to allow HTTP and HTTPS from any source to my web server at 192.168.1.100
Block all traffic from China and Russia and add them to my geo-blocking alias
Delete that risky SSH rule we created yesterday

🌐 Network Configuration

Show me all network interfaces and their current status
Create VLAN 100 on interface em0 for my IoT devices
Set up DHCP for VLAN 100 with range 10.100.1.10 to 10.100.1.200

🏷️ Alias Management

Show me all firewall aliases and what IPs are in each one
Add these suspicious IPs to my BlockedIPs alias: 192.168.100.50, 10.0.0.200
Create a new alias called "WebServers" with my internal server IPs

🔐 Certificate Management

List all my SSL certificates and show me which ones expire soon
Create a Let's Encrypt certificate for my domain example.com
Generate a certificate signing request for our internal CA

📋 User Management

Create a new read-only user called "monitoring" for our NOC team
Show me all users and their effective privileges
Reset the password for user "john.doe"

📊 Logging & Analysis

Show me the last 50 firewall blocks and identify any patterns
Analyze security events from the past 24 hours and create a threat report
Export today's logs in JSON format for analysis

🛡️ Security Operations

Perform a comprehensive security audit of my firewall configuration
Check for any weak configurations or security issues
Analyze certificate expiration status across all certificates

🔧 Advanced Operations

Create a high-availability CARP setup with VIP 192.168.1.200
Set up link aggregation between em0 and em1 using LACP
Configure outbound NAT for my new VLAN to use the WAN interface

💡 The magic: Just describe what you want in plain English, and watch your firewall configuration happen automatically!

🔒 Security Best Practices

Security MeasureImplementationWhy It Matters
🔑 Dedicated API UserCreate specific mcp-server userLimits blast radius if compromised
🎯 Minimal PrivilegesGrant only necessary permissionsPrinciple of least privilege
📍 IP RestrictionsLimit API access to your networkPrevents external API abuse
🔍 Audit LoggingEnable comprehensive loggingTrack all API activities
📊 Regular ReviewsWeekly perform_firewall_auditCatch security drift early
🔐 HTTPS OnlyForce HTTPS for web interfaceEncrypt all communications

🛡️ Security Commands to Run Regularly

Perform a comprehensive security audit and show me any issues
Check for any users with excessive privileges
Analyze recent login attempts and flag any suspicious activity
Show me all API access in the last 24 hours

⚠️ Production Environment Guidelines

🚨 Critical for Production Systems:

🔒 Maximum Security Approach
  • Disable Web GUI/API after initial setup on production firewalls
  • Console Management via direct serial cable connection
  • Configuration Staging in isolated lab environment first
🔄 Staging Workflow
  1. 🧪 Configure in secure lab environment using MCP server
  2. 🧪 Test all changes thoroughly
  3. 📤 Export configuration (config.xml)
  4. 🔒 Import to production firewall (running headless)
  5. ✅ Verify via console that changes worked
⚖️ Risk Assessment

This MCP server provides powerful automation but requires API access. Carefully evaluate:

  • 🎯 Threat Model: What are your specific risks?
  • 🔍 Monitoring: Can you detect API abuse quickly?
  • 🚫 Network Isolation: Is the management network properly segmented?
  • 👥 Team Training: Do operators understand the security implications?

🔧 Troubleshooting

🚨 Common Issues & Quick Fixes

ProblemSolutionHow to Check
🔌 Connection FailedCheck API credentials"Test my OPNsense connection"
🌐 Network UnreachableVerify firewall accessibilityping 192.168.1.1
🔑 Authentication ErrorCheck API key/secret formatRegenerate API credentials
🚫 Permission DeniedReview user privileges"Show me my user permissions"
💻 Claude Desktop IssuesCheck MCP server configRestart Claude Desktop

🔍 Diagnostic Commands

Use these commands to troubleshoot:

Test my connection to OPNsense and show me any errors
Show me the current API user permissions and privileges
Display the last 10 API calls and their results
Check if all required services are running on the firewall

📋 Step-by-Step Troubleshooting

  1. 🔍 Check Connection: curl -k https://YOUR_FIREWALL_IP/api/core/firmware/status
  2. 🔑 Verify Credentials: Ensure API key/secret are correct
  3. 🌐 Test Network: Can you access the web interface?
  4. 🛠️ Check Permissions: Does the API user have required privileges?
  5. 📱 Restart Services: Try restarting Claude Desktop
  6. 📋 Check Logs: Look at Claude Desktop console for error messages

🤝 Contributing & Community

💡 Want to Contribute?

We love contributions! Here's how you can help:

  • 🐛 Found a bug? Open an issue with details
  • 💡 Have an idea? Submit a feature request
  • 🔧 Fixed something? Create a pull request
  • 📚 Improved docs? Documentation PRs are welcome!
  • ⭐ Like the project? Give us a star on GitHub!

See CONTRIBUTING.md for detailed contribution guidelines.

🌟 Community & Support

  • 💬 Discussions: Share ideas and get help
  • 🐛 Issues: Report bugs and request features
  • 📧 Questions: Ask anything about OPNsense + MCP integration
  • 🎉 Showcase: Share your automation success stories!

📚 References & Acknowledgements

🔥 OPNsense®

This project interfaces with OPNsense firewalls - a powerful open source, FreeBSD-based firewall and routing platform.

🤖 Anthropic & Model Context Protocol (MCP)

This server implements MCP to enable AI-powered firewall management through Claude Desktop.

🎨 AI Assistance

The project logo and portions of the codebase were created with AI assistance, demonstrating the collaborative future of software development.

📜 License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.

📌 What this means:

  • ✅ Free to use for personal and commercial projects
  • ✅ Modify and distribute under the same license
  • ✅ Network use requires sharing source code modifications
  • ✅ Patent protection included

🙏 Star History & Recognition

If this project helped you manage your OPNsense firewall more effectively, please consider giving it a ⭐ on GitHub!

Together, we're making network management more accessible through AI! 🚀

This server cannot be installed

-
security - not tested
A
license - permissive license
-
quality - not tested

How are these scores calculated?

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

OPNsense MCP Server

  1. ⚡ Quick Start (5 minutes)
    1. 🧠 What is an MCP Server? Why Is It a Game Changer for AI?
      1. 🌟 Why is this revolutionary?
      2. 🚀 How does it work in practice?
    2. 🛠️ Complete Feature Set (110+ Tools!)
      1. 🔌 Connection & Configuration
      2. 🖥️ System Management
      3. 🔥 Firewall Management
      4. 📝 Alias Management
      5. 🔄 NAT Management
      6. 🌐 Network Interface Management
      7. 🔗 VLAN Management
      8. 🌉 Bridge Management
      9. ⚡ Link Aggregation (LAGG)
      10. 🏷️ Virtual IP Management
      11. 📡 DHCP Server Management
      12. 📍 DHCP Static Mappings
      13. 🔍 DNS Resolver (Unbound)
      14. ⏩ DNS Forwarder (dnsmasq)
      15. 🔐 Certificate Authority Management
      16. 📜 Certificate Management
      17. 📋 Certificate Signing Requests
      18. 🔄 ACME (Let's Encrypt) Management
      19. 🔍 Certificate Analysis & Monitoring
      20. 👥 User Management
      21. 👨‍👩‍👧‍👦 Group Management
      22. 🛡️ Privilege Management
      23. 🔑 Authentication Systems
      24. 📊 Comprehensive Logging & Monitoring
      25. 🔌 Plugin & Service Management
      26. 🌐 VPN Connection Monitoring
      27. 🚦 Traffic Shaping & QoS Management
      28. 🔧 Advanced & Custom Tools
    3. 🌟 Real-World Success Stories
      1. 🏢 Enterprise Network Management
      2. 🚨 Incident Response
      3. 📚 Learning & Training Tool
      4. 🏠 Home Lab Enthusiasts
    4. 🎯 Try These Commands!
      1. 📋 Requirements
        1. 📦 Prerequisites
          1. 🚀 Installation Guide
            1. Step 1: 📥 Clone the Repository
            2. Step 2: ⚡ Install uv (Ultra-Fast Python Manager)
            3. Step 3: 🏠 Create Virtual Environment
            4. Step 4: 📚 Install Dependencies
            5. Step 5: 🔐 Make Scripts Executable (Linux/macOS only)
            6. 🎉 Installation Complete!
          2. 🔐 Setup OPNsense API Access
            1. 🔑 Step-by-Step API Setup:
          3. 🤖 Configure Claude Desktop
            1. 🎯 Method 1: Auto-Magic Setup (Recommended)
            2. 🔧 Method 2: Manual Configuration
          4. 🎮 Usage Examples
            1. 🔌 First Steps: Connect to Your Firewall
            2. 📊 System Monitoring
            3. 🔥 Firewall Management
            4. 🌐 Network Configuration
            5. 🏷️ Alias Management
            6. 🔐 Certificate Management
            7. 📋 User Management
            8. 📊 Logging & Analysis
            9. 🛡️ Security Operations
            10. 🔧 Advanced Operations
          5. 🔒 Security Best Practices
            1. ✅ Recommended Security Setup
            2. 🛡️ Security Commands to Run Regularly
            3. ⚠️ Production Environment Guidelines
          6. 🔧 Troubleshooting
            1. 🚨 Common Issues & Quick Fixes
            2. 🔍 Diagnostic Commands
            3. 📋 Step-by-Step Troubleshooting
          7. 🤝 Contributing & Community
            1. 💡 Want to Contribute?
            2. 🌟 Community & Support
          8. 📚 References & Acknowledgements
            1. 🔥 OPNsense®
            2. 🤖 Anthropic & Model Context Protocol (MCP)
            3. 🎨 AI Assistance
          9. 📜 License
            1. 🙏 Star History & Recognition

              Related MCP Servers

              View all related MCP servers

              New MCP Servers

              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/floriangrousset/opnsense-mcp-server'

              If you have feedback or need assistance with the MCP directory API, please join our Discord server