# @chkp/documentation-mcp 中文文档

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

版本：1\.4\.17
npm 元数据更新时间：2026-11-08T14:24:37.360Z
中文译文更新时间：2026-11-09T14:00:15.665Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：136 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：7 个
- 首次发布：2025-10-19T22:00:31.353Z
- 最新版本发布：2026-11-08T14:24:36.934Z
- 近 30 天下载量：3166（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 15 个）

## 中文简介

检查点文档工具服务 - API 与检查点文档工具的集成

## 安装

```sh
npm install @chkp/documentation-mcp
```

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

## README

# 检查点文档工具 MCP

## 什么是MCP吗?

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

## 为什么检查点文档工具的MCP?

检查点文档工具通过"模式上下文协议"提供检查点文档工具服务的无缝访问. 它使AI助手能够与Check Point文档工具交互,从而更容易获得关于Check Point产品,配置,和最佳做法的准确答案.

## 与其他多边协商进程一起用于取得最佳结果

文件工具本身在文件查询方面运作良好,但设计时将与其他检查点MCP服务器(在这个检索中发现)一起使用,以提供您安全环境的全面背景,并将文件与实时系统数据联系起来.

## 特征

-   查阅检查点文件工具和知识库
-   通过文档工具查找相关文档的搜索功能
-   通过文件工具实时检索检查点产品信息
-   与人工智能助手进行结合,以获得相关帮助和指导

## 实例

### 文档查询

"寻找关于"检查点"防火墙规则配置的文件"  
_– 通过文档工具搜索并返回关于防火墙规则设置和配置最佳做法的相关检查点文档._

### 产品信息

"R81.20检查站的系统要求是什么?"  
_− 获取带有系统要求和兼容性信息的具体产品文件._

### 解决问题指导

"我如何在"检查点"中识别出VPN连通问题?"  
_——从"检查点"文档中逐步返回故障排除指南和诊断程序._

* * *

### 绩效通知

## 此服务器访问检查点文档资源, 并可能存在速率限制 。 对于最佳的性能,使用具体的查询而不是泛搜索.

## 配置选项

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

此服务器通过命令行参数或环境变量支持配置 :

### API 配置

检查点文档工具MCP服务器需要认证证书才能访问检查点文档工具服务.

#### 获得全权证书

为获得所需的API证书:

1.  **登录到无限门户**: 导航到您的检查点无限端口
2.  **访问 API 密钥**: 转到“ API 密钥” 菜单
3.  **创建新密钥**: 点击"新" "新用户 API 密钥"
4.  **保存证书**: 复制生成 `CLIENT_ID` 财务报告和审定财务报表 `SECRET_KEY`

#### 环境变量

设置以下环境变量:

-   `CLIENT_ID`: 检查点文档工具认证的客户端ID( 需要)
-   `SECRET_KEY`: 检查点文档工具认证的秘密密钥( 需要)
-   `AUTH_URL`: 认证 URL 从 API 密钥创建对话框复制(例如. `https://cloudinfra-gw.portal.checkpoint.com/auth/external`) (中文(简体) ). 建议——路径后缀被自动剥去,以便直接粘贴. 设定时, `REGION` 被推断,不需要单独设置.
-   `REGION`: 短区域代码- `EU`, (中文(简体) ), `US`, (中文(简体) ), `STG`,或 `LOCAL` (默认 : `EU`) (中文(简体) ). 用这个代替 `AUTH_URL` 用于向后兼容配置.

* * *

### 预选示例配置

关于前提的检查点文档 工具部署 :

设置以下环境变量:

-   `CLIENT_ID`: 文档工具认证的客户端ID
-   `SECRET_KEY`: 您用于文档工具认证的密钥
-   `REGION`: 设定为 `LOCAL` 现场部署

* * *

## 客户端配置

### 先决条件

下载并安装最新版本 [节点.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客户端合作.

### 基本配置示例

```json
{
  "mcpServers": {
    "checkpoint-documentation-tool": {
      "command": "npx",
      "args": ["@chkp/documentation-mcp"],
      "env": {
        "CLIENT_ID": "YOUR_CLIENT_ID",
        "SECRET_KEY": "YOUR_SECRET_KEY",
        "AUTH_URL": "YOUR_AUTH_URL"
      }
    }
  }
}
```

> **提示 :** 复制 `AUTH_URL` 直接取自 API 密钥创建对话框中显示的认证 URL 。 路径后缀被自动剥去——不需要手动编辑.

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

#### 对于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": {
    "checkpoint-documentation-tool": {
      "command": "npx",
      "args": ["@chkp/documentation-mcp"],
      "env": {
        "CLIENT_ID": "YOUR_CLIENT_ID",
        "SECRET_KEY": "YOUR_SECRET_KEY",
        "AUTH_URL": "YOUR_AUTH_URL"
      }
    }
  }
}
```

### 虚拟系统

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

```json
{
  ...
  "mcp": {
    "inputs": [],
    "servers": {
      "checkpoint-documentation-tool": {
        "command": "npx",
        "args": [
          "@chkp/documentation-mcp"
        ],
        "env": {
          "CLIENT_ID": "YOUR_CLIENT_ID",
          "SECRET_KEY": "YOUR_SECRET_KEY",
          "AUTH_URL": "YOUR_AUTH_URL"
        }
      }
    }
  },
  ...
}
```

### 风起浪起

在搜索栏中输入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/documentation-mcp
# or
npx @chkp/documentation-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": {
    "checkpoint-documentation-tool": {
      "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
# Option A: use the Authentication URL from the API key creation dialog
node FULL_PATH_TO_SERVER/packages/documentation-tool/dist/index.js \
  --client-id "YOUR_CLIENT_ID" \
  --secret-key "YOUR_SECRET_KEY" \
  --auth-url "YOUR_AUTH_URL"

# Option B: use a region code (EU / US / STG / LOCAL)
node FULL_PATH_TO_SERVER/packages/documentation-tool/dist/index.js \
  --client-id "YOUR_CLIENT_ID" \
  --secret-key "YOUR_SECRET_KEY" \
  --region "EU"
```

* * *

## 安全通知

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

## 遥测和隐私

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

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

## 常见问题

### @chkp/documentation-mcp 是什么？

检查点文档工具服务 - API 与检查点文档工具的集成

### 如何安装 @chkp/documentation-mcp？

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

### @chkp/documentation-mcp 支持 TypeScript 吗？

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

### @chkp/documentation-mcp 支持 ESM 还是 CommonJS？

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

### @chkp/documentation-mcp 需要什么版本的 Node\.js？

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

### @chkp/documentation-mcp 可以商用吗？

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

### @chkp/documentation-mcp 的下载量有多少？

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

### @chkp/documentation-mcp 还在维护吗？

最新版本 1\.4\.17 发布于 2026/11/08（1 天前）；至今共发布 19 个版本，其中过去 12 个月发布了 15 个；首次发布于 2025/10/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。