VO

vespo92/opnsensemcp

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

96 stars 19 forks Качество 81 Тренд 23MIT

vespo92/opnsensemcp - кандидат на сервер MCP, импортированный из https://github.com/vespo92/opnsensemcp.

Обзор

vespo92/opnsensemcp - кандидат на сервер MCP, импортированный из https://github.com/vespo92/opnsensemcp.

Обзор (машинный перевод)

Сервер Model Context Protocol (MCP) для комплексного управления брандмауэром OPNsense. Этот сервер позволяет помощникам ИИ, таким как Клод, напрямую управлять конфигурациями межсетевого экрана, диагностировать проблемы сети и автоматизировать сложные сетевые задачи.

Особенности

###Управление брандмауэром Полные операции CRUD для правил брандмауэра Правильная обработка созданных API «правил автоматизации»

  • Конфигурация маршрутизации Inter-VLAN Создание пакетных правил и управление ими
  • Повышенная настойчивость с несколькими методами резервного копирования

) Конфигурация NAT (на основе SSH)

  • Управление исходящими правилами NAT
  • Управление режимом NAT (автоматический/гибридный/ручный/отключенный) Правила исключения NAT для трафика между VLAN
  • Автоматическое решение проблемы DMZ NAT Непосредственная манипуляция конфигурацией XML

###Сетевая диагностика

  • Комплексный анализ маршрутизации
  • Проверка таблицы ARP с указанием поставщика Управление конфигурацией интерфейса
  • Устранение проблем с подключением к сети
  • Возможность автоматического исправления общих проблем

️ Исполнение SSH/CLI

Прямое выполнение команд на OPNsense

  • Манипулирование файлами конфигурации Операции системного уровня, недоступные через API
  • Управление услугами и перезапуск

Дополнительные возможности

Эта страница переведена автоматически. Технические детали смотрите в оригинале.

README

Показан фрагмент оригинального README. Открыть оригинал.

OPNsense MCP Server

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.

Features

🔥 Firewall Management

  • Complete CRUD operations for firewall rules
  • Proper handling of API-created “automation rules”
  • Inter-VLAN routing configuration
  • Batch rule creation and management
  • Enhanced persistence with multiple fallback methods

🌐 NAT Configuration (SSH-based)

  • Outbound NAT rule management
  • NAT mode control (automatic/hybrid/manual/disabled)
  • No-NAT exception rules for inter-VLAN traffic
  • Automated DMZ NAT issue resolution
  • Direct XML configuration manipulation

🔍 Network Diagnostics

  • Comprehensive routing analysis
  • ARP table inspection with vendor identification
  • Interface configuration management
  • Network connectivity troubleshooting
  • Auto-fix capabilities for common issues

🖥️ SSH/CLI Execution

  • Direct command execution on OPNsense
  • Configuration file manipulation
  • System-level operations not available via API
  • Service management and restarts

📊 Additional Capabilities

  • VLAN management
  • DHCP lease viewing and management
  • DNS blocklist configuration
  • HAProxy load balancer support
  • Configuration backup and restore
  • Infrastructure as Code support

Installation

Prerequisites

  • Node.js 18+ to run the server (Bun 1.1.39+ to develop on it)
  • OPNsense firewall (v24.7+ recommended)
  • API credentials for OPNsense
  • SSH access (optional, for advanced features)

Quick Start with npm

  1. Install the package:
npm install -g opnsense-mcp-server
  1. Create a .env file with your credentials:
# Required
OPNSENSE_HOST=https://your-opnsense-host:port
OPNSENSE_API_KEY=your-api-key
OPNSENSE_API_SECRET=your-api-secret
OPNSENSE_VERIFY_SSL=false

# Optional - for SSH features
OPNSENSE_SSH_HOST=your-opnsense-host
OPNSENSE_SSH_USERNAME=root
OPNSENSE_SSH_PASSWORD=your-password
# Or use SSH key
# OPNSENSE_SSH_KEY_PATH=~/.ssh/id_rsa

# Recommended for a new/production router — see "Safety Modes" below
# OPNSENSE_READ_ONLY=true
  1. Start the MCP server:
opnsense-mcp-server

⚠️ Safety Modes (read this before pointing at a production router)

By default this server can make live, immediate changes to your firewall — add/delete rules, change NAT, restart services, run whitelisted shell commands over SSH. Two environment variables (operator-only — a tool call can never set or override them) add a safety net:

Variable Effect
Открыть полный README на GitHub

Установка

npx opnsense-mcp-server
Новичок в MCP? Начните с руководства на mcpskill.org →

Конфигурация

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