@chkp/quantum-gw-cli-mcp

中文文档
1.5.3发布于 2026/11/08MITTypeScriptES Module构建来源已验证近 30 天下载 2110

Model Context Protocol (MCP) server for Check Point gateway CLI commands and diagnostic tools.

原始使用文档
文档目录35 节
  1. What is MCP?
  2. Why MCP for Gateway CLI?
  3. Features
  4. Management API Version
  5. Demo
  6. Example Use Cases
  7. Gateway Health Assessment
  8. Network Connectivity Troubleshooting
  9. Performance Bottleneck Analysis
  10. Interface Configuration Audit
  11. On-the-fly Network Dashboard
  12. "Create an iteractive visualization of currect connections …
  13. Configuration Options
  14. 1. Smart-1 Cloud (API Key)
  15. 2. On-Prem Management (API Key or Username/Password)
  16. Client Configuration
  17. Prerequisites
  18. Supported Clients
  19. Smart-1 Cloud Example
  20. On-Prem Management Example
  21. Multi-Domain Server (MDS)
  22. Configuring the Claude Desktop App
  23. VSCode
  24. Windsurf
  25. Cursor
  26. HTTP Transport
  27. Starting the server in HTTP mode
  28. Connecting an MCP client
  29. Development
  30. Prerequisites
  31. Setup
  32. Build
  33. Running Locally
  34. ⚠️ Security Notice
  35. 📊 Telemetry and Privacy

Check Point Quantum Gateway MCP Server

What is MCP?

Model Context Protocol (MCP) servers expose a structured, machine-readable API for your enterprise data—designed for AI-powered automation, copilots, and decision engines. By delivering a clear, contextual slice of your security environment, MCP lets you query, analyze, and optimize complex systems without building custom SDKs or parsing raw exports.

Why MCP for Gateway CLI?

Gateway configurations often span hundreds of routes, middleware chains, and policy rules across diverse API endpoints. Traditional CLI tools are cryptic, verbose, and hard to interpret—making understanding, monitoring, or optimizing these environments slow and error-prone. MCP changes this: exposing gateway management data in a modular, context-rich format, ready for AI systems to consume. No more deciphering complex command outputs or wrestling with arcane syntax. Enabling the AI to use your gateway data with precision. Ask real-world questions about traffic patterns, route configurations, and performance metrics—and get structured, actionable answers—instantly.

Features

  • Hardware & System Diagnostics: Query DMI decode information, asset details, and comprehensive system information
  • Network Configuration Analysis: Retrieve and analyze interface configurations, VLAN setups, and routing tables
  • High Availability Monitoring: Inspect cluster status, interface synchronization, and HA failover states
  • Performance & Security Analytics: Analyze SecureXL statistics, firewall modules, and connection acceleration metrics
  • Real-time Connection Debugging: Start and stop live connection analysis for traffic troubleshooting and diagnostics

Management API Version

This server supports Management API v2.1 (R82.10+). It is generally compatible with earlier versions; some parameters may not be available on older management servers.

Demo

Watch the demo

Example Use Cases

Gateway Health Assessment

"Create an interactive executive report for my gateway cluster? Check hardware, licenses, and HA synchronization." → Returns comprehensive health data across hardware diagnostics, licensing status, and cluster state.

Network Connectivity Troubleshooting

"Why can't traffic reach 192.168.1.10? Debug the connection path and interface status." → Traces connection flows, analyzes routing tables, and identifies interface misconfigurations.

Performance Bottleneck Analysis

"Show SecureXL acceleration stats and identify which connections are consuming resources." → Surfaces acceleration metrics, connection tables, and kernel-level performance indicators.

Interface Configuration Audit

"Create a toplogy schema for all interface configurations, ip routes and VLAN setups across my gateways." → Delivers structured network topology data showing interface states and routing information.

On-the-fly Network Dashboard

"Create an iteractive visualization of currect connections according to protocol." → Provides a dynamic report that shows network statistics in your perfered method on visualization.

Configuration Options

📊 Anonymous Usage Statistics: Check Point collects anonymous usage statistics to help improve this MCP server. To opt out, set TELEMETRY_DISABLED=true or use --no-telemetry flag.

This server supports two main modes of authentication:

1. Smart-1 Cloud (API Key)

Authenticate to Check Point Smart-1 Cloud using an API key.

  • How to generate an API key:
    In your Smart-1 Cloud dashboard, go to Settings → API & SmartConsole and generate an API key.
    Copy the key and the server login URL (excluding the /login suffix) to your client settings.
    alt text

Set the following environment variables:

  • API_KEY: Your Smart-1 Cloud API key
  • S1C_URL: Your Smart-1 Cloud tenant "Web-API" URL

2. On-Prem Management (API Key or Username/Password)

  • Configure your management server to allow API access:
    To use this server with an on-premises Check Point management server, you must first enable API access.
    Follow the official instructions for Managing Security through API.

  • Authenticate to the Security Management Server using either an API key or username/password:

    • Follow the official instructions: Managing Administrator Accounts (Check Point R81+)
    • When creating the administrator, assign appropriate permissions for API access and management operations.
    • You can authenticate using an API key (recommended for automation) or username/password credentials.

Set the following environment variables:

  • MANAGEMENT_HOST: IP address or hostname of your management server
  • PORT: (Optional) Management server port (default: 443)
  • API_KEY: Your management API key (if using API key authentication)
  • USERNAME: Username for authentication (if using username/password authentication)
  • PASSWORD: Password for authentication (if using username/password authentication)

Client Configuration

Prerequisites

Download and install the latest version of Node.js if you don't already have it installed.
You can check your installed version by running:

node -v      # Should print "v20" or higher
nvm current  # Should print "v20" or higher

Supported Clients

This server has been tested with Claude Desktop, Cursor, GitHub Copilot, and Windsurf clients.
It is expected to work with any MCP client that supports the Model Context Protocol.

Note: Due to the nature of management API calls and the variety of server tools, using this server may require a paid subscription to the model provider to support token limits and context window sizes.
For smaller models, you can reduce token usage by limiting the number of enabled tools in the client.

Smart-1 Cloud Example

{
  "mcpServers": {
    "quantum-gw-cli": {
      "command": "npx",
      "args": ["@chkp/quantum-gw-cli-mcp"],
      "env": {
        "API_KEY": "YOUR_API_KEY",
        "S1C_URL": "YOUR_S1C_URL" // e.g., https://xxxxxxxx.maas.checkpoint.com/yyyyyyy/web_api
      }
    }
  }
}

On-Prem Management Example

{
  "mcpServers": {
    "quantum-gw-cli": {
      "command": "npx",
      "args": ["@chkp/quantum-gw-cli-mcp"],
      "env": {
        "MANAGEMENT_HOST": "YOUR_MANAGEMENT_IP_OR_HOST_NAME",
        "MANAGEMENT_PORT": "443", // optional, default is 443
        "API_KEY": "YOUR_API_KEY", // or use USERNAME and PASSWORD
        "USERNAME": "YOUR_USERNAME", // optional
        "PASSWORD": "YOUR_PASSWORD"  // optional
      }
    }
  }
}

Set only the environment variables required for your authentication method.

Multi-Domain Server (MDS)

On a Multi-Domain Server, the server logs in to the System Domain and finds each gateway's domain for you.

If your credentials have no System Domain access, set MANAGEMENT_DOMAIN to a domain they can access (or pass --management-domain). The server logs in to that domain and works with that domain's gateways.

"env": {
  "MANAGEMENT_HOST": "YOUR_MDS_IP_OR_HOST_NAME",
  "MANAGEMENT_DOMAIN": "YOUR_DOMAIN", // only when you have no System Domain access
  "API_KEY": "YOUR_API_KEY"
}

Configuring the Claude Desktop App

Using a Bundled MCPB (formerly DXT)

  1. Download the MCPB file: 📥 gw-cli.mcpb
  2. Open Claude Desktop App → Settings → Extensions
  3. Drag the MCPB file and configure per the instructions.

Or Configure Manually

For macOS:

# Create the config file if it doesn't exist
touch "$HOME/Library/Application Support/Claude/claude_desktop_config.json"

# Open the config file in TextEdit
open -e "$HOME/Library/Application Support/Claude/claude_desktop_config.json"

For Windows:

code %APPDATA%\Claude\claude_desktop_config.json

Add the server configuration:

{
  "mcpServers": {
    "quantum-gw-cli": {
      "command": "npx",
      "args": ["@chkp/quantum-gw-cli-mcp"],
      "env": {
        // Add the configuration from the above instructions
      }
    }
  }
}

VSCode

Enter VSCode settings and type "mcp" in the search bar. You should see the option to edit the configuration file. Add this configuration:

{
  ...
  "mcp": {
    "inputs": [],
    "servers": {
      "quantum-gw-cli": {
        "command": "npx",
        "args": [
          "@chkp/quantum-gw-cli-mcp"
        ],
        "env": {
          "MANAGEMENT_HOST": "YOUR_MANAGEMENT_IP_OR_HOST_NAME",
          "MANAGEMENT_PORT": "443",  // optional, default is 443
          "API_KEY": "YOUR_API_KEY", // or use USERNAME and PASSWORD
          "USERNAME": "YOUR_USERNAME", // optional
          "PASSWORD": "YOUR_PASSWORD" // optional
        }
      }
    }
  },
  ...
}

Windsurf

Enter Windsurf settings and type "mcp" in the search bar. You should see the option to edit the configuration file. Add the configuration as Claude Desktop App.

Cursor

Enter Cursor settings and click on "MCP Servers" in the left menu. You should see the option to add a new MCP Server. Add the configuration as Claude Desktop App.


HTTP Transport

By default, this server uses stdio transport, which is the standard mode for MCP clients like Claude Desktop and Cursor. For hosted or multi-user deployments, an HTTP transport (MCP Streamable HTTP) is also available.

Security notice before you continue: The HTTP server has no built-in authentication and no TLS. Any client that can reach the port can establish a session, and credentials travel in cleartext. Only use HTTP transport behind an authenticated reverse proxy (nginx, Caddy, a cloud load balancer) that terminates TLS and enforces authentication. If you are running the server on the same machine as your MCP client, use the default stdio transport — it has none of these concerns.

Starting the server in HTTP mode

MCP_TRANSPORT_TYPE=http MCP_TRANSPORT_PORT=3000 npx @chkp/quantum-gw-cli-mcp
# or
npx @chkp/quantum-gw-cli-mcp --transport http --transport-port 3000

The server exposes:

  • POST/GET/DELETE /mcp — MCP protocol endpoint
  • GET /health — server status (active session count, version)

Connecting an MCP client

Point your MCP client at http://<host>:3000/mcp. Example for Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "quantum-gw-cli": {
      "url": "http://localhost:3000/mcp"
    }
  }
}

Development

Prerequisites

  • Node.js 20+
  • npm 10+

Setup

# Install all dependencies
npm install

Build

# Build all packages
npm run build

Running Locally

You can run the server locally for development using MCP Inspector or any compatible MCP client.

node FULL_PATH_TO_SERVER/packages/management/dist/index.js --s1c-url|--management-host --api-key|--username|--password

⚠️ Security Notice

  1. Authentication keys and credentials are never shared with the model. They are used only by the MCP server to authenticate with your Check Point management system.
  2. Only use client implementations you trust. Malicious or untrusted clients could misuse your credentials or access data improperly.
  3. Management data is exposed to the model. Ensure that you only use models and providers that comply with your organization's policies for handling sensitive data and PII.

📊 Telemetry and Privacy

Anonymous Usage Statistics: Check Point collects anonymous usage statistics to improve this MCP server. Only tool usage patterns and anonymous identifiers are collected—no credentials, policies, or sensitive data.

Opt-Out: Set TELEMETRY_DISABLED=true environment variable or use the --no-telemetry flag to disable telemetry collection.

版本与发布记录

@chkp/quantum-gw-cli-mcp 共发布 24 个版本,首次发布于 2025/08/05;过去 12 个月发布了 14 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.5.3latest2026/11/081 天前
1.5.22026/11/028 天前
1.4.122026/10/2515 天前
1.4.112026/10/051 个月前
1.4.92026/08/202 个月前
1.4.82026/07/133 个月前

关于 @chkp/quantum-gw-cli-mcp 的常见问题

@chkp/quantum-gw-cli-mcp 是什么?

Model Context Protocol (MCP) server for Check Point gateway CLI commands and diagnostic tools.

如何安装 @chkp/quantum-gw-cli-mcp?

在项目目录运行 npm install @chkp/quantum-gw-cli-mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 quantum-gw-cli-mcp,可以用 npx quantum-gw-cli-mcp 直接运行。

@chkp/quantum-gw-cli-mcp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@chkp/quantum-gw-cli-mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@chkp/quantum-gw-cli-mcp 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@chkp/quantum-gw-cli-mcp 可以商用吗?

@chkp/quantum-gw-cli-mcp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@chkp/quantum-gw-cli-mcp 的下载量有多少?

根据 npm 官方下载统计,@chkp/quantum-gw-cli-mcp 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,110 次,日均约 70 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@chkp/quantum-gw-cli-mcp 还在维护吗?

最新版本 1.5.3 发布于 2026/11/08(1 天前);至今共发布 24 个版本,其中过去 12 个月发布了 14 个;首次发布于 2025/08/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。