# @chkp/quantum-gw-cli-mcp 中文文档

规范地址：https://npmcn.com/package/%40chkp/quantum-gw-cli-mcp/

版本：1\.5\.3
npm 元数据更新时间：2026-11-08T14:24:35.898Z
中文译文更新时间：2026-11-09T17:29:33.749Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chkp/quantum-gw-cli-mcp
原文对照：https://npmcn.com/package/%40chkp/quantum-gw-cli-mcp/?lang=original
项目主页：https://github.com/CheckPointSW/mcp-servers#readme
源码仓库：https://github.com/CheckPointSW/mcp-servers

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：249 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：8 个
- 首次发布：2025-08-05T13:49:45.540Z
- 最新版本发布：2026-11-08T14:24:35.547Z
- 近 30 天下载量：2110（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 14 个）

## 中文简介

用于Check Point网关CLI命令和诊断工具的上下文协议(MCP)模型服务器.

## 安装

```sh
npm install @chkp/quantum-gw-cli-mcp
```

也可以使用：`pnpm add @chkp/quantum-gw-cli-mcp`、`yarn add @chkp/quantum-gw-cli-mcp`、`bun add @chkp/quantum-gw-cli-mcp`

## README

# 检查点量子网关 MCP 服务器

## 什么是MCP吗?

模式背景协议(MCP)服务器显示一个结构化的、机器可读的API,用于您的企业数据——为AI动力自动化、副驾驶和决策引擎所设计。 MCP通过提供清晰,上下文的安全环境片段,让你在不构建自定义的SDK或解析原始导出的情况下,查询,分析和优化复杂的系统.

## 为什么MCP是CLI门?

网关配置往往跨越上百条路线,中枢软件链,政策规则跨越了不同的API端点. 传统的CLI工具是加密的,动词化的,很难解释理解,监测,或优化这些环境的缓慢和容易出错. MCP改变这一点: 以模块化,内容丰富的格式曝光网关管理数据,可以随时为AI系统所消耗. 不再破译复杂的命令输出或与弧形语法相搏. 使AI能够精确地使用你的网关数据. 问真实世界有关交通模式、路线配置和性能衡量标准的问题,并立即获得结构化、可操作的答案.

## 特征

-   硬件和系统诊断:查询 DMI 解码信息、资产细节和综合系统信息
-   网络配置分析:检索和分析接口配置、VLAN设置和路由表
-   高可用性监测:检查集群状态、接口同步和HA故障状态
-   性能和安全分析:分析安全XL统计数据、防火墙模块和连接加速度量度
-   实时连接调试:开始并停止实时连接分析,用于交通故障排除和诊断

## 管理 API 版本

此服务器支持 **管理 API v2.1 (R82.10+)**. 它一般与更早的版本相容;一些参数可能无法从更老的管理服务器上获取.

## 演示

[![Watch the demo](https://img.youtube.com/vi/-DuLzDJK9Yo/0.jpg)](https://www.youtube.com/watch?v=-DuLzDJK9Yo)

## 实例

### 卫生评估网关

"为我的网关集群创建互动执行报告? 检查硬件,许可证和HA同步" _● 提供跨硬件诊断、许可证发放状况和集群状态的综合保健数据._

### 网络连接问题

"为什么交通不能达到192.168.1.10? 调试连接路径和接口状态" _^ 追踪连接流量,分析路由表,并识别界面配置错误._

### 性能 Bottleneck 分析

"显示安全XL加速数据 并确定哪些连接正在消耗资源" _• 地表加速度表、连接表和内核一级业绩指标._

### 界面配置审计

"为跨我的网关的所有接口配置,ip路由和VLAN设置创建一个顶部图案计划" _• 提供结构化网络地形数据,显示接口状态和路径信息._

### 空上网络板

## "根据协议,创建对曲霉连接的活性可视化" _——提供动态报告,在可视化的透视方法中显示网络统计._

## 配置选项

> **匿名使用统计:** 检查点收集匿名使用统计,以帮助改进这个MCP服务器. 选择退出, 设定 `TELEMETRY_DISABLED=true` 或用途 `--no-telemetry` 旗帜.

此服务器支持两个主要认证模式:

### 1\. 智能一云(API键)

授权使用 API 键检查点 Smart-1 Cloud .

-   **如何生成 API 密钥 :**  
    在你的智能一号云仪表板,去 **设置 → API & SmartConsole** 生成 API 密钥.  
    复制密钥和服务器登录 URL(不包括 `/login` 后缀)为您的客户端设置.  
    ![alt text](https://npmcn.com/package/resources/s1c_api_key.png)

设置以下环境变量:

-   `API_KEY`: 您的 Smart-1 Cloud API 键
-   `S1C_URL`: 您的智能一云租户"Web- API" URL

* * *

### 2\. Prem 管理(API 键或用户名/密码)

-   **配置您的管理服务器以允许 API 访问 :**  
    要使用此服务器, 您必须首先启用 API 访问 .  
    执行官方指示 [通过API管理安全](https://sc1.checkpoint.com/documents/R82/WebAdminGuides/EN/CP_R82_SmartProvisioning_AdminGuide/Content/Topics-SPROVG/Managing-Security-through-API.htm)。 。 。 .
    
-   **认证到安全管理服务器** 使用 API 键或用户名/密码:
    
    -   遵照官方指示: [行政主管账户(R81+点)](https://sc1.checkpoint.com/documents/R81/WebAdminGuides/EN/CP_R81_SecurityManagement_AdminGuide/Topics-SECMG/Managing_Administrator_Accounts.htm)
    -   在创建管理员时,为API访问和管理操作分配适当的权限.
    -   可以使用API密钥(为自动化推荐)或用户名/密码证书进行认证.

设置以下环境变量:

-   `MANAGEMENT_HOST`: 您管理服务器的 IP 地址或主机名
-   `PORT`: (可选) 管理服务器端口(默认: 443)
-   `API_KEY`: 您的管理 API 密钥( 如果使用 API 密钥认证)
-   `USERNAME`: 认证的用户名( 如果使用用户名/ 密码名认证)
-   `PASSWORD`: 认证密码( 如果使用用户名/ 密码认证)

* * *

## 客户端配置

### 先决条件

下载并安装最新版本 [节点.js](https://nodejs.org/en/download/) 如果你还没有安装它.  
您可以通过运行检查您的安装版本 :

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

### 支持客户端

这个服务器已经与克洛德·桌面,Cursor,GitHub Copilot,和Windsurf客户端进行了测试.  
预计它将与任何支持示范环境协议的MCP客户端合作.

> **说明:** 由于管理API调用的性质以及服务器工具的种类,使用此服务器可能需要向模型提供者付费订阅以支持令牌限制和上下文窗口大小.  
> 对于更小的模型,可以通过限制客户端中启用工具的数量来减少符号使用.

### 智能一号云示例

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

### 在线管理示例

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

> 只设定您认证方法所需的环境变量.

### 多域服务器( MDS)

在多域服务器上,服务器登录到系统域,并为您找到每个网关的域.

如果您的证书没有系统域访问权限, 设置 `MANAGEMENT_DOMAIN` 进入可以访问(或通过)的域 `--management-domain`) (中文(简体) ). 服务器登录到这个域并与那个域的网关合作.

```json
"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"
}
```

### 配置克洛德桌面应用程序

#### 使用 Bundled MCPB(原DXT)

1.  下载 MCPB 文件 : **[gw-cli.mcpb (英语)](https://github.com/CheckPointSW/mcp-servers/releases/latest/download/gw-cli.mcpb)**
2.  打开 Claude 桌面 App 设置 → 扩展
3.  拖动 MCPB 文件并按指令配置 .

#### 或者手动配置

#### 对于macOS:

```bash
# 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"
```

#### 对于 Windows :

```cmd
code %APPDATA%\Claude\claude_desktop_config.json
```

添加服务器配置 :

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

### 虚拟系统

在搜索栏中输入 VSCode 设置并键入"mcp". 您应该看到编辑配置文件的选项 . 添加此配置 :

```json
{
  ...
  "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设置并输入"mcp". 您应该看到编辑配置文件的选项 . 添加配置为 Claude 桌面 App .

### 光标

在左菜单中输入光标设置并点击"MCP服务器". 您应该看到添加一个新的 MCP 服务器的选项 . 添加配置为 Claude 桌面 App .

* * *

## HTTP 运输

默认情况下,此服务器使用 **静态** transport,是克洛德桌面和Cursor等MCP客户端的标准模式. 对主机或多用户部署 **HTTP 运输** (MCP可流式HTTP)也可用.

> **继续前的安全通知 :** HTTP服务器没有内置认证,也没有TLS. 任何能够到达端口的客户端都可以建立会话,并使用清晰文本的证书旅行. 只使用HTTP运输在认证的倒置代理(nginx, Caddy, a 云负载平衡器)后终止TLS并强制认证. 如果您正在运行与您的 MCP 客户端相同的机器上的服务器, 请使用默认的 stdio 传输 —— 它没有这些关切 .

### 以 HTTP 模式启动服务器

```bash
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
```

服务器曝光:

-   `POST/GET/DELETE /mcp` - MCP协议终点
-   `GET /health` — 服务器状态( 活动会话数, 版本)

### 连接 MCP 客户端

对准您的 MCP 客户端 `http://<host>:3000/mcp`。克劳德桌面示例`claude_desktop_config.json`:

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

* * *

## 发展

### 先决条件

-   节点.js 20+
-   npm 10+ (韩语)

### 设置

```bash
# Install all dependencies
npm install
```

### 构建

```bash
# Build all packages
npm run build
```

### 本地运行

您可以在本地运行服务器用于开发 [MCP 检查员](https://modelcontextprotocol.io/docs/tools/inspector) 或任何兼容的MCP客户端.

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

* * *

## 安全通知

1.  **认证密钥和证书从未与模型共享.** 它们只被 MCP 服务器用来认证您的 Check Point 管理系统 .
2.  **只使用您信任的客户端执行 .** 恶意或不信任的客户可能会滥用你的证书或不适当地获取数据.
3.  **管理数据被曝出该模型.** 确保您只使用符合您的组织处理敏感数据和PII的政策的模型和提供者.

## 遥测和隐私

**匿名使用统计:** Check Point收集匿名用法统计数据来改进这个MCP服务器. 只收集工具使用模式和匿名识别资料——没有证书、政策或敏感数据.

**选择退出 :** 设定 `TELEMETRY_DISABLED=true` 环境变量或使用 `--no-telemetry` 来禁用遥测收藏.

## 常见问题

### @chkp/quantum-gw-cli-mcp 是什么？

用于Check Point网关CLI命令和诊断工具的上下文协议\(MCP\)模型服务器\.

### 如何安装 @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 和提交记录判断。