PO

pixelworlds/opnsense-mcp-server

Developer tools

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요. 원문 보기

93 stars 27 forks 품질 69 트렌드 15MIT

pixelworlds/opnsense-mcp-server는 MCP 서버 후보가 https://github.com/pixelworlds/opnsense-mcp-server.에서 수입되었습니다

개요

pixelworlds/opnsense-mcp-server는 MCP 서버 후보가 https://github.com/pixelworlds/opnsense-mcp-server.에서 수입되었습니다

개요(AI 번역)

**88 모듈 기반 도구 **를 제공하는 모듈 형 모델 Context Protocol (MCP) 서버는 Type-safe TypeScript 인터페이스를 통해 2000 OPNsense 방화벽 관리 방법에 대한 액세스를 제공합니다.

특징

  • **모듈 아키텍처 ** - 88 논리 도구 (단위 당 하나) 대신 2000 + 개별 도구 -Complete API Coverage - 752 핵심 방법 및 1271 플러그인 방법 접근
  • Type-Safe - @richard-stovall/opnsense-typescript-client v0.5.3로 Full TypeScript 지원
  • **Plugin 지원 ** - 64 플러그인 모듈에 대한 옵션 지원
  • Smart Organization - 더 쉬운 발견을위한 모듈에 의해 그룹화 된 관련 작업

MCP 서버는 AI 조수 (클래드 데스크톱과 같은)와 OPNsense 방화벽 사이의 교량으로 작동하며 모듈형 도구 인터페이스를 통해 안전한 API 액세스를 제공합니다.

Claude 데스크탑에서 사용

Claude 부호에 있는 사용법

설치

MCP 서버로

이 패키지는 Claude Desktop, Cursor 또는 다른 MCP 호환 클라이언트와 같은 AI 조수와 MCP (모델 Context Protocol) 서버로 사용할 수 있도록 설계되었습니다.

# 필수품

  • Node.js 18 이상
  • API 액세스 활성화를 가진 OPNsense 방화벽
  • OPNsense 설치에서 API 키 및 비밀

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요.

README

원문 README의 일부입니다. 원문 보기.

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”
GitHub에서 전체 README 보기

설치

npx -y @richard-stovall/opnsense-mcp-server
MCP 초보자라면? mcpskill.org 가이드부터 시작하세요 →

설정

{ "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" } } } }