@cloudbase/cloudbase-mcp 1.2.1 → 1.4.0

package/README.md

@@ -45,6 +45,20 @@
 
 ## 🚀 快速开始
 
+
+### 0.前置条件
+
+#### 1. 安装 AI 开发工具
+例如：
+- [Cursor](https://www.cursor.com/) 
+- [WindSurf](https://windsurf.com/editor)  
+- [CodeBuddy](https://copilot.tencent.com/)
+
+#### 2. 开通云开发环境
+1. 访问 [腾讯云开发控制台](https://tcb.cloud.tencent.com/dev)开通环境，新用户可以免费开通体验
+2. 在控制台「概览」页面右侧获取 **环境ID**  
+   （后续部署需要此 ID）
+
 ### 1. 使用模板创建项目
 
 以下模板已经内置了云开发面向 AI IDE 的规则配置
@@ -68,7 +82,7 @@
   "mcpServers": {
     "cloudbase-mcp": {
       "command": "npx",
-      "args": ["@cloudbase/cloudbase-mcp"],
+      "args": ["@cloudbase/cloudbase-mcp@latest"],
       "env": {
         "CLOUDBASE_ENV_ID": "你的云开发环境ID"
       }
@@ -79,7 +93,7 @@
 
 2. 启用云开发 MCP Server
 
-点击 Cursor 客户端右上角的 ⚙️ 图标，点击进入之后，选择“MCP”，在 MCP Server 页面，找到 cloudbase 右边的开关按钮，点击启用
+点击 Cursor 客户端右上角的 ⚙️ 图标，点击进入之后，选择"MCP"，在 MCP Server 页面，找到 cloudbase 右边的开关按钮，点击启用
 
 #### 步骤2：添加 AI 规则
 
@@ -92,14 +106,14 @@
 
 #### 步骤1：配置 MCP
 
-点击 windsurf 的 Plugins icon，点击“View raw config”，在其中加入 clodubase-mcp，同时设置环境 id
+点击 windsurf 的 Plugins icon，点击"View raw config"，在其中加入 clodubase-mcp，同时设置环境 id
 
 ```json
 {
   "mcpServers": {
     "cloudbase-mcp": {
       "command": "npx",
-      "args": ["@cloudbase/cloudbase-mcp"],
+      "args": ["@cloudbase/cloudbase-mcp@latest"],
       "env": {
         "CLOUDBASE_ENV_ID": "你的云开发环境ID"
       }
@@ -123,7 +137,7 @@
   "mcpServers": {
     "cloudbase-mcp": {
       "command": "npx", 
-      "args": ["@cloudbase/cloudbase-mcp"],
+      "args": ["@cloudbase/cloudbase-mcp@latest"],
       "env": {
         "TENCENTCLOUD_SECRETID": "你的腾讯云SecretId",
         "TENCENTCLOUD_SECRETKEY": "你的腾讯云SecretKey",
@@ -168,7 +182,7 @@ CodeBuddy 需要手动添加规则文件：
   "mcpServers": {
     "cloudbase-mcp": {
       "command": "npx",
-      "args": ["@cloudbase/cloudbase-mcp"], 
+      "args": ["@cloudbase/cloudbase-mcp@latest"], 
       "env": {
         "CLOUDBASE_ENV_ID": "你的云开发环境ID"  
       }
@@ -289,7 +303,41 @@ graph TD
 - **⚡ 极速部署**：国内节点,访问速度比海外更快
 - **🛡️ 稳定可靠**：330 万开发者选择的 Serverless 平台
 - **🔧 开发友好**：专为AI时代设计的全栈平台
-- **💰 成本优化**：Serverless 架构支持按量付费，新用户开发期间可以免费体验
+- **💰 成本优化**：Serverless 架构更具弹性，新用户开发期间可以免费体验
+
+## 💬 技术交流群
+
+遇到问题或想要交流经验？加入我们的技术社区！
+
+### 🔥 微信交流群
+
+<div align="center">
+<img src="https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/mcp/toolkit-qrcode.png" width="200" alt="微信群二维码">
+<br>
+<i>扫码加入微信技术交流群</i>
+</div>
+
+**群内你可以：**
+- 💡 分享你的 AI + 云开发项目
+- 🤝 技术交流和开发问题沟通
+- 📢 获取最新功能更新和最佳实践
+- 🎯 参与产品功能讨论和建议
+
+### 📱 其他交流方式
+
+| 平台 | 链接 | 说明 |
+|------|------|------|
+| **官方文档** | [📖 查看文档](https://docs.cloudbase.net/) | 完整的云开发文档 |
+| **Issue 反馈** | [🐛 提交问题](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/issues) | Bug 反馈和功能请求 |
+
+### 🎉 社区活动
+
+- **每周技术分享**：群内定期分享 AI + 云开发最佳实践
+- **项目展示**：展示你用 AI 开发的精彩项目
+- **问题答疑**：腾讯云开发团队成员在线答疑
+- **新功能预览**：第一时间体验最新功能
+
+> 💡 **提示**：加群时请备注 "CloudBase AI"，方便快速通过验证
 
 ## 🤝 贡献指南
 

package/dist/index.js

@@ -7,6 +7,7 @@ import { registerDatabaseTools } from "./tools/database.js";
 import { registerHostingTools } from "./tools/hosting.js";
 import { registerDownloadTools } from "./tools/download.js";
 import { registerStorageTools } from "./tools/storage.js";
+import { registerRagTools } from './tools/rag.js';
 // Create server instance
 const server = new McpServer({
     name: "cloudbase-mcp",
@@ -18,6 +19,8 @@ const server = new McpServer({
 });
 // Register environment management tools
 registerEnvTools(server);
+// Register RAG  tools
+registerRagTools(server);
 // // Register file management tools
 // registerFileTools(server);
 // Register database management tools

package/dist/tools/env.js

@@ -4,21 +4,21 @@ import { logout } from '../auth.js';
 export function registerEnvTools(server) {
     // logout
     server.tool("logout", "登出当前云开发账户", {
-        confirm: z.literal("yes").describe("确认操作")
+        confirm: z.literal("yes").describe("确认操作，默认传 yes")
     }, async ({ confirm }) => {
         const result = await logout();
         return {
             content: [
                 {
                     type: "text",
-                    text: JSON.stringify(result, null, 2)
+                    text: "success"
                 }
             ]
         };
     });
     // listEnvs
     server.tool("listEnvs", "获取所有云开发环境信息", {
-        confirm: z.literal("yes").describe("确认操作")
+        confirm: z.literal("yes").describe("确认操作，默认传 yes")
     }, async () => {
         const cloudbase = await getCloudBaseManager();
         const result = await cloudbase.env.listEnvs();
@@ -33,7 +33,7 @@ export function registerEnvTools(server) {
     });
     // getEnvAuthDomains
     server.tool("getEnvAuthDomains", "获取云开发环境的合法域名列表", {
-        confirm: z.literal("yes").describe("确认操作")
+        confirm: z.literal("yes").describe("确认操作，默认传 yes")
     }, async () => {
         const cloudbase = await getCloudBaseManager();
         const result = await cloudbase.env.getEnvAuthDomains();
@@ -78,7 +78,7 @@ export function registerEnvTools(server) {
     });
     // getEnvInfo
     server.tool("getEnvInfo", "获取当前云开发环境信息", {
-        confirm: z.literal("yes").describe("确认操作")
+        confirm: z.literal("yes").describe("确认操作，默认传 yes")
     }, async () => {
         const cloudbase = await getCloudBaseManager();
         const result = await cloudbase.env.getEnvInfo();

package/dist/tools/hosting.js

@@ -43,7 +43,7 @@ export function registerHostingTools(server) {
     });
     // listFiles - 获取文件列表
     server.tool("listFiles", "获取静态网站托管的文件列表", {
-        confirm: z.literal("yes").describe("确认操作")
+        confirm: z.literal("yes").describe("确认操作，默认传 yes")
     }, async () => {
         const cloudbase = await getCloudBaseManager();
         const result = await cloudbase.hosting.listFiles();
@@ -165,7 +165,7 @@ export function registerHostingTools(server) {
     });
     // getWebsiteConfig - 获取静态网站配置
     server.tool("getWebsiteConfig", "获取静态网站配置", {
-        confirm: z.literal("yes").describe("确认操作")
+        confirm: z.literal("yes").describe("确认操作，默认传 yes")
     }, async () => {
         const cloudbase = await getCloudBaseManager();
         const result = await cloudbase.hosting.getWebsiteConfig();

package/dist/tools/rag.js

@@ -0,0 +1,108 @@
+import { z } from "zod";
+// 1. 枚举定义
+const KnowledgeBaseEnum = z.enum(["cloudbase", "scf"]);
+// 2. 枚举到后端 id 的映射
+const KnowledgeBaseIdMap = {
+    cloudbase: "ykfzskv4_ad28",
+    scf: "scfsczskzyws_4bdc",
+};
+// 安全 JSON.parse
+function safeParse(str) {
+    try {
+        return JSON.parse(str);
+    }
+    catch (e) {
+        return {};
+    }
+}
+// 安全 JSON.stringify，处理循环引用
+function safeStringify(obj) {
+    const seen = new WeakSet();
+    try {
+        return JSON.stringify(obj, function (key, value) {
+            if (typeof value === "object" && value !== null) {
+                if (seen.has(value))
+                    return;
+                seen.add(value);
+            }
+            return value;
+        });
+    }
+    catch (e) {
+        return "";
+    }
+}
+export function registerRagTools(server) {
+    // 知识库检索
+    server.tool('search_knowledge_base', '云开发知识库智能检索工具，支持云开发与云函数知识的向量查询', {
+        threshold: z.number().default(0.5).optional().describe("相似性检索阈值"),
+        id: KnowledgeBaseEnum.describe("知识库范围，cloudbase=云开发全量知识，scf=云开发的云函数知识"),
+        content: z.string().describe("检索内容"),
+        options: z.object({
+            chunkExpand: z.array(z.number()).min(2).max(2).default([3, 3]).describe("指定返回的文档内容的展开长度,例如 [3,3]代表前后展开长度"),
+        }).optional().describe("其他选项"),
+        limit: z.number().default(5).optional().describe("指定返回最相似的 Top K 的 K 的值")
+    }, async ({ id, content, options: { chunkExpand = [3, 3] } = {}, limit = 5, threshold = 0.5 }) => {
+        // 枚举到后端 id 映射
+        const backendId = KnowledgeBaseIdMap[id] || id;
+        const signInRes = await fetch('https://tcb-advanced-a656fc.api.tcloudbasegateway.com/auth/v1/signin/anonymously', {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Accept': 'application/json',
+                'x-device-id': 'cloudbase-ai-toolkit'
+            },
+            body: safeStringify({
+                collectionView: backendId,
+                options: {
+                    chunkExpand
+                },
+                search: {
+                    content: content,
+                    limit
+                }
+            })
+        });
+        const token = (await signInRes.json()).access_token;
+        const res = await fetch(`https://tcb-advanced-a656fc.api.tcloudbasegateway.com/v1/knowledge/search`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': `Bearer ${token}`
+            },
+            body: safeStringify({
+                collectionView: backendId,
+                options: {
+                    chunkExpand
+                },
+                search: {
+                    content: content,
+                    limit
+                }
+            })
+        });
+        const result = await res.json();
+        if (result.code) {
+            throw new Error(result.message);
+        }
+        console.log(result);
+        return {
+            content: [{
+                    type: "text",
+                    text: safeStringify(result.data.documents
+                        .filter((item) => item.score >= threshold)
+                        .map((item) => {
+                        return {
+                            score: item.score,
+                            fileTile: item.documentSet.fileTitle,
+                            url: safeParse(item.documentSet.fileMetaData).url,
+                            paragraphTitle: item.data.paragraphTitle,
+                            text: `${item.data.pre?.join('\n') || ''}
+${item.data.text}
+${item.data.next?.join('\n') || ''}`,
+                        };
+                    }))
+                }]
+        };
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/cloudbase-mcp",
-  "version": "1.2.1",
+  "version": "1.4.0",
   "description": "腾讯云开发 MCP Server，支持静态托管/环境查询/",
   "main": "index.js",
   "type": "module",