@chkp/documentation-mcp 0.1.7 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @chkp/documentation-mcp
 
+## 1.1.0
+
+### Minor Changes
+
+- 3870c17: Updated implementation and features, Updated configuration, Modified 3 file(s) (synced from internal repository)
+
+## 1.0.1
+
+### Patch Changes
+
+- 2c71da0: Updated configuration, Modified 2 file(s) (synced from internal repository)
+
 ## 0.1.7
 
 ### Patch Changes

package/README.md

@@ -40,6 +40,8 @@ This server accesses Check Point documentation resources and may have rate limit
 
 ## 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
@@ -85,8 +87,8 @@ Download and install the latest version of [Node.js](https://nodejs.org/en/downl
 You can check your installed version by running:
 
 ```bash
-node -v      # Should print "v18" or higher
-nvm current  # Should print "v18" or higher
+node -v      # Should print "v20" or higher
+nvm current  # Should print "v20" or higher
 ```
 
 ### Supported Clients
@@ -195,7 +197,7 @@ Add the configuration as Claude Desktop App.
 
 ### Prerequisites
 
-- Node.js 18+  
+- Node.js 20+  
 - npm 10+  
 
 ### Setup
@@ -226,4 +228,10 @@ node FULL_PATH_TO_SERVER/packages/copilot/dist/index.js --client-id "YOUR_CLIENT
 
 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.
+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.

package/dist/index.js

@@ -362,7 +362,6 @@ var init_ui_dialog = __esm({
 
 // src/index.ts
 import { z } from "zod";
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 
 // ../mcp-utils/dist/launcher.js
 import { Command } from "commander";
@@ -393,12 +392,26 @@ async function launchMCPServer(configPath, serverModule2) {
   program.option("--transport-port <number>", "Port for network transports (e.g., HTTP)", transportPortDefault);
   const debugDefault = process.env.DEBUG === "true" || false;
   program.option("--debug", "Enable debug mode", debugDefault);
+  const telemetryEnabledDefault = process.env.TELEMETRY_DISABLED === "true" ? false : true;
+  program.option("--no-telemetry", "Disable anonymous usage telemetry", telemetryEnabledDefault);
+  const telemetryUrlDefault = process.env.TELEMETRY_URL || "https://metrics.security.ai.checkpoint.com/api/v1/metrics/collect";
+  program.option("--telemetry-url <url>", "URL for telemetry server", telemetryUrlDefault);
   program.parse(process.argv);
   const options = program.opts();
+  if (options.telemetry === false) {
+    process.env.TELEMETRY_DISABLED = "true";
+  }
+  if (options.telemetryUrl) {
+    process.env.TELEMETRY_URL = options.telemetryUrl;
+  }
   if (!serverModule2.settingsManager) {
     throw new Error("ServerModule must have a settingsManager. Create it with createServerModule.");
   }
   const settings = serverModule2.settingsManager.createFromArgs(options);
+  if (typeof serverModule2.server.applyToolPolicy === "function") {
+    console.error("[launchMCPServer] Applying tool policy before connecting");
+    serverModule2.server.applyToolPolicy();
+  }
   const transportType = (options.transport || process.env.MCP_TRANSPORT_TYPE || "stdio").toLowerCase() === "http" ? "http" : "stdio";
   const transportPort = options.transportPort ? parseInt(options.transportPort, 10) : process.env.MCP_TRANSPORT_PORT ? parseInt(process.env.MCP_TRANSPORT_PORT, 10) : 3e3;
   if (transportType === "http") {
@@ -1126,27 +1139,178 @@ function createApiRunner(serverModule2) {
     return await apiManager.callApi(method, uri, data, domain);
   };
 }
-function createServerModule(server2, Settings2, pkg2, apiManagerClass) {
+function createServerModule(server2, Settings2, pkg2, apiManagerClass, toolPolicyCallback) {
   const settingsManager = new SettingsManager(Settings2);
   const apiManagerFactory = new APIManagerFactory(apiManagerClass, settingsManager);
   const sessionManager = new SessionManager();
+  if (toolPolicyCallback && typeof server2.setToolPolicy === "function") {
+    console.error("[createServerModule] Setting tool policy callback on server");
+    server2.setToolPolicy(toolPolicyCallback);
+  }
   return {
     server: server2,
     Settings: Settings2,
     settingsManager,
     apiManagerFactory,
     sessionManager,
-    pkg: pkg2
+    pkg: pkg2,
+    toolPolicyCallback
   };
 }
 
 // ../mcp-utils/dist/index.js
 init_ui_dialog();
 
-// src/index.ts
+// ../mcp-utils/dist/telemetry.js
+import machineIdPkg from "node-machine-id";
+import { createHash } from "crypto";
+var { machineIdSync } = machineIdPkg;
+var machineId = null;
+var hashedMachineId = null;
+function isTelemetryDisabled() {
+  return process.env.TELEMETRY_DISABLED === "true" || process.env.TELEMETRY_DISABLED === "1";
+}
+function getTelemetryUrl() {
+  return process.env.TELEMETRY_URL || "https://metrics.security.ai.checkpoint.com/api/v1/metrics/collect";
+}
+function hashString(input) {
+  return createHash("sha256").update(input).digest("hex");
+}
+function getMachineId() {
+  if (!machineId) {
+    try {
+      machineId = machineIdSync();
+    } catch (error) {
+      console.warn("Failed to get machine ID for telemetry:", error);
+      machineId = "unknown";
+    }
+  }
+  return machineId;
+}
+function getHashedMachineId() {
+  if (!hashedMachineId) {
+    hashedMachineId = hashString(getMachineId());
+  }
+  return hashedMachineId;
+}
+function calculateChecksum(mcpName, toolName, machineId2, clientVersion) {
+  const data = mcpName + machineId2.slice(0, 16) + toolName + clientVersion;
+  return hashString(data);
+}
+async function trackToolCall(mcpName, toolName, clientVersion, extra) {
+  if (isTelemetryDisabled()) {
+    return;
+  }
+  try {
+    const machineId2 = getHashedMachineId();
+    const checksum = calculateChecksum(mcpName, toolName, machineId2, clientVersion);
+    fetch(getTelemetryUrl(), {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({
+        mcp_name: mcpName,
+        tool_name: toolName,
+        machine_id: machineId2,
+        client_version: clientVersion,
+        checksum
+      })
+    }).catch(() => {
+    });
+  } catch (error) {
+  }
+}
+
+// ../mcp-utils/dist/mcp-server.js
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+var CPMcpServer = class extends McpServer {
+  constructor(serverInfo, options) {
+    super(serverInfo, options);
+    this.mcpName = serverInfo.name;
+    this.mcpVersion = serverInfo.version || "0.0.0";
+  }
+  /**
+   * Set a tool policy callback to filter which tools are available
+   * This should be called after all tools are registered but before connecting
+   * @param callback Function that returns true if a tool should be enabled
+   */
+  setToolPolicy(callback) {
+    console.error("[CPMcpServer] Setting tool policy callback");
+    this.toolPolicyCallback = callback;
+  }
+  /**
+   * Apply the tool policy by checking all registered tools
+   * This should be called after all tools are registered but before connecting
+   */
+  applyToolPolicy() {
+    if (!this.toolPolicyCallback) {
+      console.error("[CPMcpServer] No tool policy callback set, allowing all tools");
+      return;
+    }
+    console.error("[CPMcpServer] Applying tool policy");
+    const registeredTools = this._registeredTools;
+    if (!registeredTools || typeof registeredTools !== "object") {
+      console.error("[CPMcpServer] No tools registered yet");
+      return;
+    }
+    const toolNames = Object.keys(registeredTools);
+    console.error(`[CPMcpServer] Found ${toolNames.length} registered tools:`, toolNames);
+    let enabledCount = 0;
+    let disabledCount = 0;
+    for (const [toolName, tool] of Object.entries(registeredTools)) {
+      const isAllowed = this.toolPolicyCallback(toolName);
+      if (!isAllowed) {
+        console.error(`[CPMcpServer] Tool '${toolName}' is NOT allowed by policy - disabling`);
+        if (typeof tool.disable === "function") {
+          tool.disable();
+          disabledCount++;
+        }
+      } else {
+        console.error(`[CPMcpServer] Tool '${toolName}' is allowed by policy`);
+        enabledCount++;
+      }
+    }
+    console.error(`[CPMcpServer] Policy applied: ${enabledCount}/${toolNames.length} tools enabled, ${disabledCount} disabled`);
+  }
+  // Override the tool method to wrap callbacks with telemetry
+  tool(...args) {
+    const callback = args[args.length - 1];
+    if (typeof callback === "function") {
+      const toolName = args[0];
+      const wrappedCallback = async (...callbackArgs) => {
+        const extra = callbackArgs[1];
+        trackToolCall(this.mcpName, toolName, this.mcpVersion, extra).catch(() => {
+        });
+        return callback(...callbackArgs);
+      };
+      args[args.length - 1] = wrappedCallback;
+    }
+    return super.tool(...args);
+  }
+};
+
+// ../mcp-utils/dist/package-utils.js
 import { readFileSync } from "fs";
 import { join as join2, dirname } from "path";
 import { fileURLToPath } from "url";
+function readPackageJson(importMetaUrl) {
+  const pkg2 = JSON.parse(readFileSync(join2(dirname(fileURLToPath(importMetaUrl)), "../package.json"), "utf-8"));
+  process.env.CP_MCP_MAIN_PKG = `${pkg2.name} v${pkg2.version}`;
+  return pkg2;
+}
+function createMcpServer(importMetaUrl, serverInfo, options) {
+  const pkg2 = readPackageJson(importMetaUrl);
+  const fullServerInfo = {
+    ...serverInfo,
+    name: serverInfo.name || pkg2.name,
+    version: serverInfo.version || pkg2.version
+  };
+  const server2 = new CPMcpServer(fullServerInfo, options);
+  return { server: server2, pkg: pkg2 };
+}
+
+// src/index.ts
+import { join as join3, dirname as dirname2 } from "path";
+import { fileURLToPath as fileURLToPath2 } from "url";
 
 // src/documentation-api-manager.ts
 import axios3 from "axios";
@@ -1428,17 +1592,9 @@ var DocumentationToolSettings = class _DocumentationToolSettings extends Setting
 };
 
 // src/index.ts
-var pkg = JSON.parse(
-  readFileSync(
-    join2(dirname(fileURLToPath(import.meta.url)), "../package.json"),
-    "utf-8"
-  )
-);
-process.env.CP_MCP_MAIN_PKG = `${pkg.name} v${pkg.version}`;
-var server = new McpServer({
+var { server, pkg } = createMcpServer(import.meta.url, {
   name: "checkpoint-documentation",
-  description: "Comprehensive Check Point documentation assistant providing instant access to product information, technical specifications, configuration guidance, and feature documentation across the entire Check Point security portfolio.",
-  version: "1.0.0"
+  description: "Comprehensive Check Point documentation assistant providing instant access to product information, technical specifications, configuration guidance, and feature documentation across the entire Check Point security portfolio."
 });
 var serverModule = createServerModule(
   server,
@@ -1544,7 +1700,7 @@ server.tool(
 );
 var main = async () => {
   await launchMCPServer(
-    join2(dirname(fileURLToPath(import.meta.url)), "server-config.json"),
+    join3(dirname2(fileURLToPath2(import.meta.url)), "server-config.json"),
     serverModule
   );
 };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chkp/documentation-mcp",
-  "version": "0.1.7",
+  "version": "1.1.0",
   "description": "Check Point Documentation Tool Service - API integration with Check Point Documentation Tool",
   "type": "module",
   "main": "dist/index.js",
@@ -15,7 +15,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
     "clean": "rimraf dist",
@@ -29,12 +29,13 @@
     "@modelcontextprotocol/sdk": "^1.11.1",
     "axios": "^1.12.1",
     "commander": "^13.1.0",
+    "node-machine-id": "^1.1.12",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@chkp/mcp-utils": "*",
     "@chkp/quantum-infra": "*",
-    "@types/node": "^18.15.11",
+    "@types/node": "^20.0.0",
     "dotenv": "^17.2.2",
     "tsx": "^4.20.5",
     "typescript": "^5.0.4"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chkp/documentation-mcp",
-  "version": "0.1.7",
+  "version": "1.1.0",
   "description": "Check Point Documentation Tool Service - API integration with Check Point Documentation Tool",
   "type": "module",
   "main": "dist/index.js",
@@ -15,7 +15,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
     "clean": "rimraf dist",
@@ -29,12 +29,13 @@
     "@modelcontextprotocol/sdk": "^1.0.4",
     "commander": "^13.1.0",
     "axios": "^1.12.1",
+    "node-machine-id": "^1.1.12",
     "zod": "^3.24.4"
   },
   "devDependencies": {
     "@chkp/mcp-utils": "*",
     "@chkp/quantum-infra": "*",
-    "@types/node": "^18.15.11",
+    "@types/node": "^20.0.0",
     "dotenv": "^17.2.2",
     "tsx": "^4.20.5",
     "typescript": "^5.0.4"