モジュラーモデルコンテキストプロトコル(MCP)サーバーで、88モジュールベースのツールは、タイプセーフなTypeScriptインターフェースを介して2000以上のOPNsenseファイアウォール管理方法へのアクセスを提供します。

##特徴

-Modular Architecture - 2000以上の個々のツールの代わりに88の論理ツール(1モジュールあたり)

• 完全な API の適用範囲 - 752 の中心方法および 1271 のプラグイン方法へのアクセス
• Type-Safe - @richard-stovall/opnsense-typescript-client v0.5.3 との完全な TypeScript サポート
• プラグインサポート - 64プラグインモジュールのオプションサポート -スマート組織 - より容易な発見のためのモジュールによってグループ化される関連操作

MCP サーバーは、AI アシスタント (Claude Desktop のような) と OPNsense ファイアウォール間のブリッジとして機能し、モジュール式ツール インターフェイスを介して安全な API アクセスを提供します。

Claudeデスクトップでの使用

クロード コードの使用法

インストール

##MCP サーバーとして

このパッケージは、Claude Desktop、Cursor、その他のMCP対応クライアントなどのAIアシスタントでMCP(Model Context Protocol)サーバーとして使用されるように設計されています。

前提条件

• Node.js 18以上
• APIアクセス対応のOPNsenseファイアウォール
• OPNsenseの取付けからのAPIのキーそして秘密

OPNsense MCP Server

A modular Model Context Protocol (MCP) server that provides 88 module-based tools giving access to over 2000 OPNsense firewall management methods through a type-safe TypeScript interface.

Features

• Modular Architecture - 88 logical tools (one per module) instead of 2000+ individual tools
• Complete API Coverage - Access to 752 core methods and 1271 plugin methods
• Type-Safe - Full TypeScript support with @richard-stovall/opnsense-typescript-client v0.5.3
• Plugin Support - Optional support for 64 plugin modules
• Smart Organization - Related operations grouped by module for easier discovery

The MCP server acts as a bridge between AI assistants (like Claude Desktop) and your OPNsense firewall, providing secure API access through a modular tool interface.

Usage in Claude Desktop

Usage in Claude Code

Installation

As an MCP Server

This package is designed to be used as an MCP (Model Context Protocol) server with AI assistants like Claude Desktop, Cursor, or other MCP-compatible clients.

Prerequisites

• Node.js 18 or higher
• An OPNsense firewall with API access enabled
• API key and secret from your OPNsense installation

Install from npm

npm install -g @richard-stovall/opnsense-mcp-server

Usage as an MCP Server

Claude Desktop Configuration

Add the following to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "opnsense": {
      "command": "npx",
      "args": ["-y", "@richard-stovall/opnsense-mcp-server"],
      "env": {
        "OPNSENSE_URL": "https://192.168.1.1",
        "OPNSENSE_API_KEY": "your-api-key",
        "OPNSENSE_API_SECRET": "your-api-secret",
        "OPNSENSE_VERIFY_SSL": "false"
      }
    }
  }
}

Alternative Configuration Methods

Using Command Line Arguments:

{
  "mcpServers": {
    "opnsense": {
      "command": "node",
      "args": [
        "/path/to/opnsense-mcp-server/index.js",
        "--url",
        "https://YOUR-OPNSENSE-IP",
        "--api-key",
        "YOUR-API-KEY",
        "--api-secret",
        "YOUR-API-SECRET",
        "--no-verify-ssl"
      ]
    }
  }
}

Enable Plugin Tools: To include all 64 plugin module tools, add "--plugins" to the args or set "INCLUDE_PLUGINS": "true" in env.

Testing the Setup

Once configured, you can test the connection by asking Claude:

• “What MCP tools are available?”
• “Use core_manage to get the system status”