cls-mcp-server 0.1.0 → 0.2.1

package/README.md

@@ -10,7 +10,9 @@ Follow [Node.js](https://nodejs.org/) instructions to install Node.js.
 
 ### MCP Server Setup
 
-To configure `cls-mcp-server` as an MCP service, add the following JSON configuration to your `mcpServers` settings:
+#### Stdio (Recommend)
+
+To configure `cls-mcp-server` as an MCP service in stdio transport, add the following JSON configuration to your `mcpServers` settings:
 
 ```json
 {
@@ -26,6 +28,7 @@ To configure `cls-mcp-server` as an MCP service, add the following JSON configur
         "cls-mcp-server"
       ],
       "env": {
+        "TRANSPORT": "stdio",
         "TENCENTCLOUD_SECRET_ID": "YOUR_TENCENT_SECRET_ID",
         "TENCENTCLOUD_SECRET_KEY": "YOUR_TENCENT_SECRET_KEY",
         "TENCENTCLOUD_API_BASE_HOST": "tencentcloudapi.com",
@@ -37,10 +40,61 @@ To configure `cls-mcp-server` as an MCP service, add the following JSON configur
 }
 ```
 
-Replace `YOUR_TENCENT_SECRET_KEY` and `YOUR_TENCENT_SECRET_ID` with your actual Tencent Cloud credentials.
+Go to [Environment value explanation](#environment-value-explanation) for detail explanation.
+
+#### SSE
+
+1. Create `.env` in current path, config environment values:
+
+```
+TRANSPORT=sse
+TENCENTCLOUD_SECRET_ID=YOUR_TENCENT_SECRET_ID
+TENCENTCLOUD_SECRET_KEY=YOUR_TENCENT_SECRET_KEY
+TENCENTCLOUD_API_BASE_HOST=tencentcloudapi.com
+TENCENTCLOUD_REGION=ap-guangzhou
+MAX_LENGTH=15000
+PORT=3000
+```
+
+2. Install `cls-mcp-server` globally by npm
+
+```
+npm install -g cls-mcp-server@latest
+```
+
+3. Run `cls-mcp-server` command to start sse server
+
+```
+cls-mcp-server
+```
+
+4. Config your `mcpServers` settings
+
+```json
+{
+  "mcpServers": {
+    "cls-mcp-server": {
+      "name": "cls-mcp-server",
+      "type": "sse",
+      "isActive": true,
+      "baseUrl": "http://localhost:3000/sse"
+    }
+  }
+}
+```
+
+Go to [Environment value explanation](#environment-value-explanation) for detail explanation.
+
+#### Environment value explanation
+
+Replace `TRANSPORT` value to config MCP transport, `stdio` or `sse`. Default `stdio`.
+
+Replace `YOUR_TENCENT_SECRET_ID` and `YOUR_TENCENT_SECRET_KEY` with your actual Tencent Cloud credentials.
+
+Replace `TENCENTCLOUD_API_BASE_HOST` value if you need to change base host of Tencent Cloud API. Default "tencentcloudapi.com".
 
-Replace `TENCENTCLOUD_API_BASE_HOST` if you need to change base host of Tencent Cloud API. Default "tencentcloudapi.com".
+Replace `TENCENTCLOUD_REGION` value with your desired default region. Will only take effect if no region input from AI.
 
-Replace `TENCENTCLOUD_REGION` with your desired default region. If no region input from AI.
+Replace `MAX_LENGTH` value to fit token length requirement of your AI model. If not provided, will send entire response to AI model.
 
-Replace `MAX_LENGTH` to fit token length requirement of your AI model. If not provided, will send entire response to AI model.
+Replace `PORT` value to change sse server port. Default `3000`. Will only take effect in sse transport.

package/dist/index.js

@@ -1,13 +1,18 @@
 #!/usr/bin/env node
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const tencentcloud_sdk_nodejs_cls_1 = require("tencentcloud-sdk-nodejs-cls");
-const tencentcloud_sdk_nodejs_region_1 = require("tencentcloud-sdk-nodejs-region");
-// eslint-disable-next-line import/no-unresolved
 const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
-// eslint-disable-next-line import/no-unresolved
+const sse_js_1 = require("@modelcontextprotocol/sdk/server/sse.js");
 const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
+require("dotenv/config");
+const express_1 = __importDefault(require("express"));
+const tencentcloud_sdk_nodejs_cls_1 = require("tencentcloud-sdk-nodejs-cls");
+const tencentcloud_sdk_nodejs_region_1 = require("tencentcloud-sdk-nodejs-region");
 const zod_1 = require("zod");
+console.log(process.env); // remove this after you've confirmed it is working
 const ClsClient = tencentcloud_sdk_nodejs_cls_1.cls.v20201016.Client;
 const RegionClient = tencentcloud_sdk_nodejs_region_1.region.v20220627.Client;
 // Initialize MCP server
@@ -273,12 +278,31 @@ const formatResponse = (data, isError) => {
         isError: !!isError,
     };
 };
-async function main() {
-    const transport = new stdio_js_1.StdioServerTransport();
-    await mcpServer.connect(transport);
-    // console.log('Cls MCP Server running on stdio');
+function main() {
+    const transport = process.env.TRANSPORT;
+    if (transport === 'sse') {
+        const app = (0, express_1.default)();
+        let transport = null;
+        app.get('/sse', (req, res) => {
+            transport = new sse_js_1.SSEServerTransport('/messages', res);
+            mcpServer.connect(transport).catch((error) => {
+                console.error('Fatal error in main():', error);
+                process.exit(error?.code || 1);
+            });
+        });
+        app.post('/messages', (req, res) => {
+            if (transport) {
+                transport.handlePostMessage(req, res);
+            }
+        });
+        app.listen(process.env.PORT ? Number(process.env.PORT) : 3000);
+    }
+    else {
+        const stdioTransport = new stdio_js_1.StdioServerTransport();
+        mcpServer.connect(stdioTransport).catch((error) => {
+            console.error('Fatal error in main():', error);
+            process.exit(error?.code || 1);
+        });
+    }
 }
-main().catch((error) => {
-    // console.error('Fatal error in main():', error);
-    process.exit(error?.code || 1);
-});
+main();

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "cls-mcp-server",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "main": "index.js",
   "files": [
     "dist"
   ],
   "bin": {
-    "cls-mcp-server": "./dist/index.js"
+    "cls-mcp-server": "dist/index.js"
   },
   "scripts": {
     "build": "tsc && chmod 755 dist/index.js",
     "lint": "eslint -c .eslintrc.js --fix --quiet src/**/*.ts src/**/*.tsx",
     "prepare": "husky",
     "publish": "npm run build && npm publish --registry=\"https://registry.npmjs.org/\"",
-    "postinstall": "patch-package"
+    "postinstall": "patch-package",
+    "start:sse": "npm run build && node ./dist/index.js"
   },
   "keywords": [],
   "author": "",
@@ -21,6 +22,7 @@
   "description": "",
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.9.0",
+    "dotenv": "^16.5.0",
     "express": "^5.1.0",
     "lighthouse-mcp-server": "^0.0.6",
     "lodash.isnil": "^4.0.0",