opnsense-mcp

MCP运维云端

提供方 digitalhen

运维云端 stdio · 本地进程 OAuth 授权 社区 / 第三方 Claude

An MCP server that connects Claude and other MCP clients to your OPNsense router via its API, providing full management of 20+ core modules including firewall, VPN, DNS, DHCP, and diagnostics, enabling network administrators to operate and configure their network with AI assistance.

一句话选型结论

按资料字段整理

opnsense-mcp 属于运维云端类 MCP 服务器,stdio · 本地进程,OAuth 授权,可直接接入 Claude,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类运维云端 传输方式stdio · 本地进程 鉴权OAuth 授权 部署方式本地部署
GitHub 星标 1 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

运维云端
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

Local Deployment MCP Server OPNsense TypeScript Network Management Firewall VPN DNS DHCP Router

支持客户端

适用场景

Local DeploymentMCP ServerOPNsense

安装与配置

stdio · 本地进程 OAuth 授权
客户端在本机拉起子进程,数据不出本机
  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 node,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
云资源查询

查实例、存储、账单等云上资源状态。

部署与发布

把部署、重启、回滚这类操作接进对话。

监控与告警

拉取监控指标,异常时让模型帮你判断。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 已适配 Claude,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 使用前要准备好OAuth 授权对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在运维云端场景里让模型直接调用外部能力的人。
  • 已经在用 Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
opnsense-mcp当前 未标注 stdio · 本地进程 本地部署 无 2026-03-29
lobehub 未标注 stdio · 本地进程 本地部署 有 2026-04-11
TrendRadar 未标注 stdio · 本地进程 本地部署 有 2026-04-13
Ui Tars Desktop 8a825770 未标注 stdio · 本地进程 本地部署 有 2026-05-17
ruflo 未标注 stdio · 本地进程 本地部署 有 2026-04-13
FastGPT 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

运维云端
字段来自项目仓库与公开索引,中文说明由本站标注
提供方digitalhen上游标注的维护方 digitalhen
分类运维云端本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式OAuth 授权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · node本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-03-29上游最后核验时间

详细介绍

4.8 KB
来自项目仓库与上游目录的原文,未做删改

OPNsense MCP Server

A hosted Model Context Protocol server that gives Claude (and other MCP clients) full access to your OPNsense router's API. Connects Claude.ai to your firewall, diagnostics, VPN, DNS, DHCP, and 20+ other OPNsense modules via a single MCP integration.

Inspired by Pixelworlds/opnsense-mcp-server, rebuilt from scratch with a focus on reliability and Claude.ai hosted MCP support.

Features

  • 24 core tool modules covering firewall, diagnostics, interfaces, VPN (WireGuard/OpenVPN/IPsec), DNS, DHCP, and more
  • 750+ methods auto-discovered from the OPNsense TypeScript SDK with per-method parameter introspection
  • OAuth 2.0 + PKCE for secure authentication from Claude.ai
  • Retry with backoff on transient API failures (5xx, timeouts, connection resets)
  • Structured logging with timestamps and component tags
  • Graceful shutdown on SIGTERM/SIGINT
  • Optional plugin support — enable INCLUDE_PLUGINS=true to expose 60+ additional plugin modules

Architecture```

Claude.ai → Cloudflare Tunnel → MCP Server (Node.js) → OPNsense API
↑
OAuth 2.0 bearer token


The server runs natively on your LAN (not in Docker) so it can reach the OPNsense router directly. A Cloudflare Tunnel (or similar reverse proxy) exposes it to Claude.ai.

## Quick start

### 1. Create an OPNsense API key

In your OPNsense web UI: **System > Access > Users > edit your user > API keys > +**

### 2. Configure```bash
cp .env.example .env
# Edit .env with your API key, secret, OAuth password, and public URL

3. Build and run```bash

npm install
npm run build
npm start


### 4. Connect Claude.ai

Add the MCP server in Claude.ai settings using your public URL (e.g. `https://opnsense-mcp.yourdomain.com`). Claude will redirect to the OAuth flow — enter the password you set in `OAUTH_PASSWORD`.

## Running as a service (macOS)

Create a launchd plist at `~/Library/LaunchAgents/com.opnsense-mcp.plist`:```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Label</key>
    <string>com.opnsense-mcp</string>
    <key>WorkingDirectory</key>
    <string>/path/to/opnsense-mcp</string>
    <key>ProgramArguments</key>
    <array>
        <string>/opt/homebrew/bin/node</string>
        <string>/path/to/opnsense-mcp/dist/server.js</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>KeepAlive</key>
    <true/>
    <key>StandardErrorPath</key>
    <string>/path/to/opnsense-mcp/logs/stderr.log</string>
</dict>
</plist>

Then load it:```bash
mkdir -p logs
launchctl load ~/Library/LaunchAgents/com.opnsense-mcp.plist


## Environment variables

| Variable | Required | Default | Description |
|---|---|---|---|
| `OPNSENSE_URL` | | `https://192.168.50.1` | Router API URL |
| `OPNSENSE_API_KEY` | Yes | | API key from OPNsense |
| `OPNSENSE_API_SECRET` | Yes | | API secret from OPNsense |
| `OPNSENSE_VERIFY_SSL` | | `true` | Set to `false` for self-signed certs |
| `OAUTH_PASSWORD` | Yes | | Password for the OAuth authorize form |
| `PUBLIC_URL` | Yes | | Public URL (e.g. Cloudflare Tunnel hostname) |
| `INCLUDE_PLUGINS` | | `false` | Enable OPNsense plugin modules |
| `TOKEN_TTL_HOURS` | | `24` | OAuth token lifetime in hours |
| `PORT` | | `3100` | Server listen port |
| `LOG_LEVEL` | | `info` | Logging level: debug, info, warn, error |

## Available tools

Each tool exposes all methods from the corresponding OPNsense API module:

| Tool | Description | Methods |
|---|---|---|
| `core_manage` | System management, backups, dashboard | 46 |
| `firewall_manage` | Rules, aliases, categories, NAT | 67 |
| `diagnostics_manage` | Ping, traceroute, DNS, netstat, packet capture, netflow | 90 |
| `interfaces_manage` | Network interfaces, VIPs, VLANs | 63 |
| `ipsec_manage` | IPsec VPN tunnels and status | 80 |
| `unbound_manage` | Unbound DNS resolver and DNSBL | 42 |
| `wireguard_manage` | WireGuard VPN peers and status | 28 |
| `openvpn_manage` | OpenVPN servers and clients | 28 |
| `ids_manage` | Intrusion Detection (Suricata) | 40 |
| `firmware_manage` | Firmware updates and packages | 26 |
| `auth_manage` | Users, groups, and privileges | 19 |
| `trust_manage` | Certificates and CAs | 25 |
| ...and 12 more | DHCP, DNS, routing, traffic shaping, etc. | |

With `INCLUDE_PLUGINS=true`, 60+ additional plugin modules are available (HAProxy, Caddy, Tailscale, CrowdSec, etc.).

## Project structure```
src/
  config.ts    — Environment validation
  logger.ts    — Structured logging
  tools.ts     — Tool discovery, parameter introspection, retry logic
  oauth.ts     — OAuth 2.0 with PKCE
  server.ts    — Express app, MCP transport, graceful shutdown

License

MIT

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
opnsense-mcp 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

opnsense-mcp 怎么在 Claude 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

opnsense-mcp 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

opnsense-mcp 需要 API Key 吗?

资料标注需要OAuth 授权认证,使用前准备好对应凭据,并按最小权限配置。

opnsense-mcp 支持哪些客户端?

资料标注支持 Claude;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

opnsense-mcp 能提供哪些能力?

资料显示能力标签包括 Local Deployment、MCP Server、OPNsense、TypeScript、Network Management、Firewall。具体工具清单以官方文档为准。

opnsense-mcp 需要什么运行环境?

运行时为 node;属于本地进程,需要在本机装好运行环境。

opnsense-mcp 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-03-29。