@chkp/documentation-mcp

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

Check Point Documentation Tool Service - API integration with Check Point Documentation Tool

原始使用文档
文档目录31 节
  1. What is MCP?
  2. Why MCP for Check Point Documentation Tool?
  3. Use with other MCPs for Best Results
  4. Features
  5. Example Use Cases
  6. Documentation Lookup
  7. Product Information
  8. Troubleshooting Guidance
  9. ⚠️ Performance Notice
  10. This server accesses Check Point documentation resources an…
  11. Configuration Options
  12. API Configuration
  13. On-Prem Example Configuration
  14. Client Configuration
  15. Prerequisites
  16. Supported Clients
  17. Basic Configuration Example
  18. Configuring the Claude Desktop App
  19. VSCode
  20. Windsurf
  21. Cursor
  22. HTTP Transport
  23. Starting the server in HTTP mode
  24. Connecting an MCP client
  25. Development
  26. Prerequisites
  27. Setup
  28. Build
  29. Running Locally
  30. ⚠️ Security Notice
  31. 📊 Telemetry and Privacy

Check Point Documentation Tool MCP

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 Check Point Documentation Tool?

The Check Point Documentation Tool provides seamless access to Check Point Documentation Tool services through the Model Context Protocol. It enables AI assistants to interact with Check Point Documentation Tool, making it easier to get accurate answers about Check Point products, configurations, and best practices.

Use with other MCPs for Best Results

While the Documentation Tool works well on its own for documentation queries, it is designed to be used alongside other Check Point MCP servers (found in this repo) to provide comprehensive context about your security environment and correlate documentation with live system data.

Features

  • Access to Check Point Documentation Tool services and knowledge base
  • Search functionality for finding relevant documentation through Documentation Tool
  • Real-time retrieval of Check Point product information via Documentation Tool
  • Integration with AI assistants for contextual help and guidance

Example Use Cases

Documentation Lookup

"Find documentation about Check Point firewall rule configuration."
→ Searches and returns relevant Check Point documentation about firewall rule setup and configuration best practices through Documentation Tool.

Product Information

"What are the system requirements for Check Point R81.20?"
→ Retrieves specific product documentation with system requirements and compatibility information.

Troubleshooting Guidance

"How do I troubleshoot VPN connectivity issues in Check Point?"
→ Returns step-by-step troubleshooting guides and diagnostic procedures from Check Point documentation.


⚠️ Performance Notice

This server accesses Check Point documentation resources and may have rate limits. For best performance, use specific queries rather than broad searches.

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 configuration via command-line arguments or environment variables:

API Configuration

The Check Point Documentation Tool MCP server requires authentication credentials for accessing Check Point Documentation Tool services.

Acquiring Credentials

To obtain the required API credentials:

  1. Login to Infinity Portal: Navigate to your Check Point Infinity Portal
  2. Access API Keys: Go to the "API Keys" menu
  3. Create New Key: Click "New" → "New User API Key"
  4. Save Credentials: Copy the generated CLIENT_ID and SECRET_KEY

Environment Variables

Set the following environment variables:

  • CLIENT_ID: Client ID for authentication with Check Point Documentation Tool (required)
  • SECRET_KEY: Secret Key for authentication with Check Point Documentation Tool (required)
  • AUTH_URL: Authentication URL copied from the API key creation dialog (e.g. https://cloudinfra-gw.portal.checkpoint.com/auth/external). Recommended — the path suffix is stripped automatically so you can paste it directly. When set, REGION is inferred and does not need to be set separately.
  • REGION: Short region code — EU, US, STG, or LOCAL (default: EU). Use this instead of AUTH_URL for backwards-compatible configurations.

On-Prem Example Configuration

For on-premises Check Point Documentation Tool deployment:

Set the following environment variables:

  • CLIENT_ID: Your client ID for Documentation Tool authentication
  • SECRET_KEY: Your secret key for Documentation Tool authentication
  • REGION: Set to LOCAL for on-premises deployment

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.

Basic Configuration Example

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

Tip: Copy AUTH_URL directly from the Authentication URL shown in the API key creation dialog. The path suffix is stripped automatically — no manual editing needed.

Configuring the Claude Desktop App

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

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

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/documentation-mcp
# or
npx @chkp/documentation-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": {
    "checkpoint-documentation-tool": {
      "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.

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

⚠️ 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/documentation-mcp 共发布 19 个版本,首次发布于 2025/10/20;过去 12 个月发布了 15 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.4.17latest2026/11/081 天前
1.4.162026/11/027 天前
1.4.132026/10/2514 天前
1.4.122026/10/051 个月前
1.4.102026/08/202 个月前
1.4.92026/07/133 个月前

关于 @chkp/documentation-mcp 的常见问题

@chkp/documentation-mcp 是什么?

Check Point Documentation Tool Service - API integration with Check Point Documentation Tool

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