OPNsense MCP/LLM工具包
使用自然语言和任何兼容MCP的LLM配置OPNsense防火墙。
这是什么
一个完整的工具包，允许您使用Claude、Cursor、OpenCode或其他LLM通过对话配置OPNsense防火墙。包括一个增强的MCP服务器，带有用于WireGuard、PF状态、网关和别名的其他工具。
"Create a guest VLAN that can access the internet but not my LAN"
"Forward port 443 to my web server at 192.168.1.50"
"Show me all firewall rules blocking traffic"
"Check WireGuard tunnel status"______________________________________________________________________
快速开始
- 获取API凭据 从OPNsense（系统>访问>用户>API密钥）
- 安装并运行MCP服务器:
cd opnsense-mcp-server
npm install
npm run build- 添加MCP服务器 到LLM客户端配置：
{
"mcpServers": {
"opnsense": {
"command": "node",
"args": ["/path/to/opnsense-mcp-server/dist/index.js"],
"env": {
"OPNSENSE_HOST": "https://192.168.1.1",
"OPNSENSE_API_KEY": "your_key",
"OPNSENSE_API_SECRET": "your_secret",
"OPNSENSE_VERIFY_SSL": "false"
}
}
}
}- 添加系统提示 从
llm/SYSTEM_PROMPT.md按照法学硕士的指示 - 开始聊天 -“测试我的OPNsense连接”
完整的设置说明： 设置.md
______________________________________________________________________
用户指南预览
该工具包包括一份全面的78页PDF指南，涵盖了从初始设置到高级配置的所有内容。
Download Full PDF Guide
______________________________________________________________________
包含什么
| 目录/文件 | 目的 |
|---|---|
opnsense-mcp-server/ | 具有WireGuard、PF状态、网关、别名工具的增强型MCP服务器 |
llm/SYSTEM_PROMPT.md | 为LLM复制粘贴提示 |
llm/OPNSENSE_KNOWLEDGE.md | 详细参考（MCP工具、工作流程、模式） |
docs/OPNsense_User_Guide.pdf | 78页人类可读指南 |
SETUP.md | 分步设置说明 |
MCP服务器功能
在基本opnesse mcp服务器的基础上增强了以下功能：
- WireGuard工具 -隧道状态、对等管理
- PF状态工具 -查看/清除数据包过滤器状态
- 网关工具 -监控网关状态和故障转移
- Alias工具 -管理防火墙别名
- SSH支持 -直接CLI访问以进行高级操作
______________________________________________________________________
运作原理
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ You │────>│ LLM │────>│ OPNsense │
│ (natural │ │ (with MCP │ │ (firewall) │
│ language) │<────│ tools) │<────│ │
└─────────────┘ └─────────────┘ └─────────────┘
│
MCP Server +
Knowledge BaseLLM使用：
- MCP工具 在OPNsense（API+SSH）上执行命令
- 知识档案 了解OPNsense概念和最佳实践
- 系统提示 遵循安全指南（先备份，解释更改等）
______________________________________________________________________
需求
- 启用API访问的OPNsense防火墙
- 支持MCP的LLM客户端（Claude Desktop、Cursor、OpenCode、Continue.dev）
- Node.js 18+
项目结构
OPNsense-MCP-LLM-Toolkit/
├── README.md
├── SETUP.md # Setup instructions
├── opnsense-mcp-server/ # Enhanced MCP server
│ ├── src/ # Server source code
│ ├── package.json
│ └── README.md # Server-specific docs
├── llm/
│ ├── SYSTEM_PROMPT.md # LLM instructions
│ └── OPNSENSE_KNOWLEDGE.md # Reference material
├── docs/
│ ├── OPNsense_User_Guide.pdf # Full PDF guide
│ └── images/ # Preview images
└── src/
└── opnsense_user_guide.py # PDF generator______________________________________________________________________
许可证
麻省理工学院
______________________________________________________________________
*与OPNsense项目无关。OPNsense是Deciso B.V.的商标。*