cloudcc-cli 2.2.1 → 2.2.3

package/README.md

@@ -1,3 +1,24 @@
+# ReleaseV2.2.3
+#### Release Date: 2025-12-11
+#### Release Scope: Full
+#### Release Content
+* Optimization
+    * Add development environment setup MCP service
+    * Add security key retrieval MCP service
+    * Add Class management MCP service
+    * Add custom component management MCP service
+    * Configuration information prioritized from config
+    * Fix script tag search logic
+
+# ReleaseV2.2.2
+#### Release Date: 2025-12-3
+#### Release Scope: Full
+#### Release Content
+* Optimization
+    * Added links to development documentation and changelog to version check output
+    * Upgraded Node dependencies to version 20
+    * Added timestamp output to multiple files to enhance user experience
+
 # ReleaseV2.2.1
 #### Release Date: 2025-11-24
 #### Release Scope: Full

package/bin/cc.js

@@ -52,6 +52,7 @@ cc.recordType = require("../src/recordType/index")
 cc.config = require("../src/config/index")
 
 cc.version = require("../src/version/index")
+
 try {
     cc[argvs[1]](argvs[0], argvs);
 } catch (e) {

package/bin/mcp.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+/**
+ * MCP (Model Context Protocol) 服务启动脚本
+ * 用于与 Claude Desktop、IDE 等客户端通信
+ */
+
+const { StdioServerTransport } = require('@modelcontextprotocol/sdk/server/stdio.js');
+const mcpServer = require('../src/mcp/index.js');
+
+async function main() {
+    const transport = new StdioServerTransport();
+    await mcpServer.connect(transport);
+}
+
+main().catch(error => {
+    console.error('Server error:', error);
+    process.exit(1);
+});

package/package.json

@@ -1,30 +1,36 @@
 {
   "name": "cloudcc-cli",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "cloudcc-cli",
+  "author": "cloudcc",
+  "license": "ISC",
   "keywords": [
     "cloudcc",
     "cloudcc-cli"
   ],
   "main": "./bin",
-  "author": "cloudcc",
-  "license": "ISC",
   "bin": {
     "cloudccCreate": "bin/project.js",
     "cloudccBuild": "bin/plugin.js",
-    "cc": "bin/cc.js"
+    "cc": "bin/cc.js",
+    "cc-mcp": "bin/mcp.js"
   },
   "scripts": {
     "cc-pull": "git fetch --tags -f && git pull",
     "publish-lib": "npm publish --registry https://registry.npmjs.org && git add . && git commit -m 'update' && git push && curl https://npmmirror.com/sync/cloudcc-cli",
-    "package-jar": "mvn clean && mvn package"
+    "package-jar": "mvn clean && mvn package",
+    "fetch-dev-env": "node src/mcp/tools/dev-env/fetcher.js",
+    "fetch-key-guide": "node src/mcp/tools/key-guide/fetcher.js",
+    "fetch-ccdk": "node src/mcp/tools/ccdk/fetcher.js"
   },
   "dependencies": {
     "@babel/parser": "^7.28.5",
     "@babel/traverse": "^7.28.5",
+    "@modelcontextprotocol/sdk": "^1.23.0",
     "axios": "^0.21.4",
     "boxen": "^4.0.0",
     "chalk": "^2.4.2",
+    "cheerio": "^1.0.0-rc.12",
     "crypto-js": "^4.1.1",
     "dayjs": "^1.10.7",
     "fs-extra": "^11.2.0",
@@ -32,7 +38,9 @@
     "marked": "^5.0.1",
     "mem-fs": "^2.2.1",
     "mem-fs-editor": "^9.0.1",
+    "node-fetch": "^3.3.2",
     "vue-custom-element": "^3.3.0",
-    "vue-template-compiler": "^2.6.14"
+    "vue-template-compiler": "^2.6.14",
+    "zod": "^4.1.13"
   }
 }

package/src/classes/create.js

@@ -58,6 +58,7 @@ public class ${name}Test {
             console.log()
             console.log(chalk.red("Creation Class Failed:" + e))
             console.log()
+            throw new Error("Creation Class Failed: " + e);
         }
     }
 }

package/src/classes/get.js

@@ -15,6 +15,7 @@ async function get(arg, path) {
         return res.data.list
     } else {
         console.error('error:', res.message);
+        throw new Error('Get Class Failed: ' + res.message);
     }
 }
 

package/src/classes/publish.js

@@ -13,6 +13,9 @@ async function publish(name) {
   let res = await checkUpdate();
   if (!res) {
     console.log();
+    const now = new Date();
+    const timeStr = now.getFullYear() + '-' + String(now.getMonth() + 1).padStart(2, '0') + '-' + String(now.getDate()).padStart(2, '0') + ' ' + String(now.getHours()).padStart(2, '0') + ':' + String(now.getMinutes()).padStart(2, '0') + ':' + String(now.getSeconds()).padStart(2, '0');
+    console.log(chalk.green(timeStr));
     console.log(chalk.green('Posting, please wait...'));
     console.log();
     const classPath = path.join(process.cwd(), `classes/${name}/`);
@@ -41,6 +44,7 @@ async function publish(name) {
       }
     } else {
       console.log(chalk.red('Publish Class Failed：' + res.returnInfo));
+      throw new Error('Publish Class Failed: ' + res.returnInfo);
     }
   }
 }

package/src/classes/pull.js

@@ -12,13 +12,16 @@ async function pull(name) {
     let res = await checkUpdate();
     if (!res) {
         console.log();
+        const now = new Date();
+        const timeStr = now.getFullYear() + '-' + String(now.getMonth() + 1).padStart(2, '0') + '-' + String(now.getDate()).padStart(2, '0') + ' ' + String(now.getHours()).padStart(2, '0') + ':' + String(now.getMinutes()).padStart(2, '0') + ':' + String(now.getSeconds()).padStart(2, '0');
+        console.log(chalk.green(timeStr));
         console.log(chalk.green('Pulling, please wait...'));
         console.log();
         const classPath = path.join(process.cwd(), `classes/${name}/`);
         let configContent = JSON.parse(fs.readFileSync(classPath + "config.json", 'utf8'));
         if (!configContent.id) {
             console.log(chalk.red('Class ID is not exist, please publish first！'));
-            return;
+            throw new Error('Class ID is not exist, please publish first!');
         }
         let body = {
             "id": configContent.id,
@@ -45,6 +48,7 @@ async function pull(name) {
 
         } else {
             console.log(chalk.red('Pull Class Failed：' + res.returnInfo));
+            throw new Error('Pull Class Failed: ' + res.returnInfo);
         }
     }
 }

package/src/mcp/index.js

@@ -0,0 +1,227 @@
+/**
+ * MCP 服务核心（标准 I/O 版本）
+ * 用于与 Claude / IDE 等客户端通信
+ * 
+ * 重构说明：
+ * - 每个工具都在独立的文件夹中，包含 prompt.js（知识库）、fetcher.js（爬取工具）、handler.js（工具实现）
+ * - 主文件负责统一注册所有工具
+ */
+
+const { McpServer } = require("@modelcontextprotocol/sdk/server/mcp.js");
+const { z } = require("zod");
+
+// 导入各个工具的处理器
+const ccdkHandler = require("./tools/ccdk/handler.js");
+const devEnvHandler = require("./tools/dev-env/handler.js");
+const classesHandler = require("./tools/classes/handler.js");
+const keyGuideHandler = require("./tools/key-guide/handler.js");
+const pluginHandler = require("./tools/plugin/handler.js");
+
+const mcpServer = new McpServer({
+    name: 'cctool',
+    version: '1.0.0'
+});
+
+// ==================== CCDK 工具 ====================
+
+// Tool: Get CCDK documentation (full or by module)
+mcpServer.registerTool(
+    'get_ccdk_docs',
+    {
+        description: '获取 CloudCC CCDK API 文档。可以获取完整文档或指定模块的文档（如 CCPage、CCDetail、CCList 等）',
+        inputSchema: {
+            module: z.string().optional().describe('可选：指定模块名称，如 "CCPage"、"CCDetail"、"CCCommon" 等。不指定则返回所有模块概览')
+        }
+    },
+    ccdkHandler.getCcdkDocs
+);
+
+// Tool: Search CCDK documentation
+mcpServer.registerTool(
+    'search_ccdk_docs',
+    {
+        description: '在 CCDK 文档中搜索关键词，支持搜索 API 名称、方法名、功能描述等',
+        inputSchema: {
+            keyword: z.string().describe('搜索关键词'),
+            maxResults: z.number().optional().default(20)
+        }
+    },
+    ccdkHandler.searchCcdkDocs
+);
+
+// Tool: List CCDK modules
+mcpServer.registerTool(
+    'list_ccdk_modules',
+    {
+        description: '列出 CCDK 所有可用的 API 模块',
+        inputSchema: {
+            showApis: z.boolean().optional().default(false)
+        }
+    },
+    ccdkHandler.listCcdkModules
+);
+
+// ==================== Dev-Env 工具 ====================
+
+// Tool: Get dev environment setup guide
+mcpServer.registerTool(
+    'get_dev_env_setup',
+    {
+        description: '获取 CloudCC 开发环境搭建指南',
+        inputSchema: z.object({
+            step: z.number().int().optional(),
+            search: z.string().optional(),
+            difficulty: z.enum(['easy', 'medium', 'hard']).optional(),
+            platform: z.enum(['windows', 'macos', 'linux']).optional(),
+            command: z.boolean().optional(),
+        })
+    },
+    devEnvHandler.getDevEnvSetup
+);
+
+// ==================== Classes 工具 ====================
+
+// Tool: Create custom class
+mcpServer.registerTool(
+    'create_class',
+    {
+        description: '创建一个新的 CloudCC 自定义类，会在 classes/{ClassName}/ 目录下生成 Java 类文件、测试文件和配置文件',
+        inputSchema: {
+            className: z.string().min(1).describe('Java 类名，必须符合 Java 命名规范（字母开头，只能包含字母、数字和下划线）'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    classesHandler.createClass
+);
+
+// Tool: Publish class to server
+mcpServer.registerTool(
+    'publish_class',
+    {
+        description: '将本地自定义类发布到 CloudCC 服务器，只上传 @SOURCE_CONTENT_START 和 @SOURCE_CONTENT_END 之间的代码',
+        inputSchema: {
+            className: z.string().min(1).describe('要发布的类名'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    classesHandler.publishClass
+);
+
+// Tool: Pull class from server
+mcpServer.registerTool(
+    'pull_class',
+    {
+        description: '从 CloudCC 服务器拉取自定义类的最新代码，更新本地文件中 @SOURCE_CONTENT_START 和 @SOURCE_CONTENT_END 之间的内容',
+        inputSchema: {
+            className: z.string().min(1).describe('要拉取的类名'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    classesHandler.pullClass
+);
+
+// Tool: List classes
+mcpServer.registerTool(
+    'list_classes',
+    {
+        description: '获取 CloudCC 服务器上的自定义类列表',
+        inputSchema: {
+            queryParams: z.object({}).passthrough().optional().describe('查询条件，JSON 对象格式，例如 {"name": "MyClass"}'),
+            limit: z.number().int().positive().optional().default(20).describe('返回结果数量限制，默认 20'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    classesHandler.listClasses
+);
+
+// Tool: Get class detail
+mcpServer.registerTool(
+    'get_class_detail',
+    {
+        description: '获取本地自定义类的详细信息，包括配置、文件路径和源码预览',
+        inputSchema: {
+            className: z.string().min(1).describe('类名'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    classesHandler.getClassDetail
+);
+
+// Tool: Pull multiple classes
+mcpServer.registerTool(
+    'pull_multiple_classes',
+    {
+        description: '批量从 CloudCC 服务器拉取多个自定义类，适用于初始化项目或批量下载。遇到错误会继续处理其他类，最后返回统计结果',
+        inputSchema: {
+            classIds: z.array(z.string()).min(1).describe('要拉取的类 ID 数组，例如 ["id1", "id2", "id3"]'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    classesHandler.pullMultipleClasses
+);
+
+// Tool: Edit class with knowledge base
+mcpServer.registerTool(
+    'edit_class',
+    {
+        description: '获取编辑 CloudCC 自定义类时所需的知识库、API 文档和代码示例。包含 CCService、CCObject、SendEmail、TimeUtil、UserInfo、DevLogger 等核心 API 的详细使用说明。代码示例和最佳实践会自动附加 CloudCC 标准 API 规范检查表，确保编辑后的代码符合 CloudCC 官方标准',
+        inputSchema: {
+            topic: z.enum(['overview', 'ccservice', 'object', 'email', 'time', 'user', 'logger', 'scenarios', 'bestpractices'])
+                .optional()
+                .default('overview')
+                .describe(`知识库主题:
+- overview: 类概览和快速导航
+- ccservice: CCService 数据操作 API（查询、新增、更新、删除等）
+- object: CCObject 对象操作方法
+- email: SendEmail 邮件服务
+- time: TimeUtil 时间格式化工具
+- user: UserInfo 用户信息获取
+- logger: DevLogger 日志输出
+- scenarios: 常见编辑场景示例
+- bestpractices: 编辑最佳实践`)
+        }
+    },
+    classesHandler.editClass
+);
+
+// ==================== Key Guide 工具 ====================
+
+// Tool: Get security key guide
+mcpServer.registerTool(
+    'get_key_guideeee',
+    {
+        description: '获取 CloudCC 安全标记和开发者密钥相关的完整指南，包括获取开发者密钥、安全标记、配置方法等',
+        inputSchema: z.object({})
+    },
+    keyGuideHandler.getKeyGuide
+);
+
+// ==================== Plugin 工具 ====================
+
+// Tool: Create plugin
+mcpServer.registerTool(
+    'create_plugin',
+    {
+        description: '创建一个新的 CloudCC Vue 自定义组件，会在 plugins/{pluginName}/ 目录下生成主组件文件、子组件目录和配置文件',
+        inputSchema: {
+            pluginName: z.string().min(1).describe('插件名称，用于创建目录和主文件'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    pluginHandler.createPlugin
+);
+
+// Tool: Publish plugin
+mcpServer.registerTool(
+    'publish_plugin',
+    {
+        description: '将 Vue 自定义组件编译并发布到 CloudCC 服务器。会自动收集所有依赖、编译为 UMD 格式并上传',
+        inputSchema: {
+            pluginName: z.string().min(1).describe('要发布的插件名称'),
+            projectPath: z.string().describe('项目根目录路径，默认为当前工作目录')
+        }
+    },
+    pluginHandler.publishPlugin
+);
+
+module.exports = mcpServer;

package/src/mcp/readme.md

@@ -0,0 +1,132 @@
+## MCP设计方案
+* 每个功能独立一个工具
+
+## 工具列表说明
+### 1:开发环境检查Tool
+* 用于检查当前环境，是否满足开发条件
+* 需要使用知识库
+
+### 2:创建开发环境Tool
+* 通过特定步骤创建一个开发模版项目
+* 需要使用知识库
+
+### 3:指导配置开发者密钥Tool
+* 检查当前环境的开发者密钥是否配置正确
+* 指导如何获取密钥，以及如何配置
+
+### 4:创建应用程序Tool
+* 创建一个应用程序
+
+### 5:查询应用列表
+* 查询环境所有应用程序
+
+### 6:创建自定义对象Tool
+* 创建一个自定义对象
+
+### 7:查询对象列表Tool
+* 查询所有对象信息，包含标准以及自定义
+
+### 8:查询某个对象的详细信息Tool
+* 查询某个对象的详细信息
+
+### 9:创建字段Tool
+* 为某个对象批量创建字段
+* 需要所有字段知识库
+
+### 10:查询某个对象字段列表Tool
+* 通过对象id查询对象的字段列表信息
+
+### 11:创建自定义类Tool
+* 创建一个自定义类
+
+### 12:查询自定义类列表Tool
+* 查询自定义类列表
+
+### 13:查询某个类的详细信息Tool
+* 根据id查询某个类详细信息
+
+### 14:编辑类Tool
+* 使用类的开发者知识库进行编辑开发
+* 类的常用sdk
+
+### 15:拉取自定义类到本地Tool
+* 拉取线上的某个类代码到本地
+
+### 16:推送自定义类到线上Tool
+* 推送某个自定义类代码到线上
+
+### 17:创建定时类Tool
+* 创建一个自定义类
+
+### 18:查询定时类列表Tool
+* 查询自定义类列表
+
+### 19:查询某个定时类的详细信息Tool
+* 根据id查询某个类详细信息
+
+### 20:编辑定时类Tool
+* 使用定时类的开发者知识库进行编辑开发
+* 类的常用sdk
+
+### 21:拉取定时类到本地Tool
+* 拉取线上的某个类代码到本地
+
+### 22:推送定时类代码到线上Tool
+* 推送某个自定义类代码到线上
+
+### 23:创建触发器Tool
+* 创建一个自定义类
+
+### 24:查询触发器列表Tool
+* 查询自定义类列表
+
+### 25:查询某个触发器的详细信息Tool
+* 根据id查询某个类详细信息
+
+### 26:编辑触发器Tool
+* 使用定时类的开发者知识库进行编辑开发
+* 类的常用sdk
+
+### 27:拉取触发器到本地Tool
+* 拉取线上的某个类代码到本地
+
+### 28:推送触发器代码到线上Tool
+* 推送某个自定义类代码到线上
+
+### 29:创建自定义组件Tool
+* 创建一个自定义类
+
+### 30:查询自定义组件列表Tool
+* 查询自定义类列表
+
+### 31:查询某个自定义组件的详细信息Tool
+* 根据id查询某个类详细信息
+
+### 32:编辑自定义组件Tool
+* 使用定时类的开发者知识库进行编辑开发
+* 类的常用sdk
+
+### 33:拉取自定义组件到本地Tool
+* 拉取线上的某个类代码到本地
+
+### 34:推送自定义组件代码到线上Tool
+* 推送某个自定义类代码到线上
+
+### 35:创建客户端脚本Tool
+* 创建一个自定义类
+
+### 36:查询客户端脚本组件列表Tool
+* 查询自定义类列表
+
+### 37:查询某个客户端脚本的详细信息Tool
+* 根据id查询某个类详细信息
+
+### 38:编辑客户端脚本Tool
+* 使用定时类的开发者知识库进行编辑开发
+* 类的常用sdk
+
+### 39:拉取客户端脚本到本地Tool
+* 拉取线上的某个类代码到本地
+
+### 40:推送客户端脚本件代码到线上Tool
+* 推送某个自定义类代码到线上

package/src/mcp/tools/ccdk/fetcher.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+/**
+ * CCDK API 文档爬取工具
+ * 用于从 CloudCC 官方文档爬取 CCDK API 信息并生成结构化知识库
+ * 
+ * TODO: 实现 CCDK 文档的自动爬取功能
+ * 目前 CCDK 文档是手动维护的，未来可以添加自动爬取功能
+ */
+
+console.log('CCDK 文档爬取工具');
+console.log('注意：当前 CCDK 文档为手动维护，暂无自动爬取功能');
+console.log('如需更新文档，请手动编辑 prompt.js 文件');
+
+// 预留：未来可以添加从官方文档网站爬取 CCDK API 的功能
+// 参考 dev-env 的实现方式
+
+process.exit(0);

package/src/mcp/tools/ccdk/handler.js

@@ -0,0 +1,98 @@
+/**
+ * CCDK 工具处理器
+ * 提供 CCDK API 文档查询、搜索等功能的具体实现
+ */
+
+const { ccdkApiTree } = require('./prompt.js');
+
+/**
+ * 获取 CCDK 文档（完整或指定模块）
+ */
+async function getCcdkDocs({ module } = {}) {
+    const tree = ccdkApiTree;
+
+    if (module) {
+        const moduleInfo = tree[module];
+        if (moduleInfo) {
+            let content = `# ${module} - ${moduleInfo.name}\n\n${moduleInfo.description}\n\n---\n\n`;
+            Object.entries(moduleInfo.apis).forEach(([apiName, apiInfo]) => {
+                content += `## ${apiName}\n\n**描述**: ${apiInfo.description}\n\n**版本**: ${apiInfo.version}\n\n${apiInfo.content}\n\n---\n\n`;
+            });
+            return { content: [{ type: 'text', text: content }] };
+        } else {
+            const modules = Object.keys(tree);
+            return { content: [{ type: 'text', text: `未找到 "${module}" 模块的文档。\n\n可用模块：\n${modules.map(m => `- ${m}`).join('\n')}` }] };
+        }
+    } else {
+        let content = '# CloudCC CCDK API 模块概览\n\n';
+        Object.entries(tree).forEach(([moduleName, moduleInfo]) => {
+            const apiCount = Object.keys(moduleInfo.apis).length;
+            content += `## ${moduleName} - ${moduleInfo.name}\n\n${moduleInfo.description}\n\n**API 数量**: ${apiCount}\n\n---\n\n`;
+        });
+        content += '\n💡 使用 `get_ccdk_docs` 工具并指定 `module` 参数获取模块详细文档';
+        return { content: [{ type: 'text', text: content }] };
+    }
+}
+
+/**
+ * 搜索 CCDK 文档
+ */
+async function searchCcdkDocs({ keyword, maxResults = 20 }) {
+    const tree = ccdkApiTree;
+    const keywordLower = keyword.toLowerCase();
+    const results = [];
+
+    Object.entries(tree).forEach(([moduleName, moduleInfo]) => {
+        Object.entries(moduleInfo.apis).forEach(([apiName, apiInfo]) => {
+            let score = 0;
+            if (apiName.toLowerCase() === keywordLower) score += 100;
+            else if (apiName.toLowerCase().includes(keywordLower)) score += 50;
+            if (apiInfo.keyword.toLowerCase().includes(keywordLower)) score += 30;
+            if (apiInfo.description.toLowerCase().includes(keywordLower)) score += 20;
+            if (apiInfo.content.toLowerCase().includes(keywordLower)) score += 10;
+            if (moduleInfo.name.toLowerCase().includes(keywordLower)) score += 15;
+            if (moduleInfo.description.toLowerCase().includes(keywordLower)) score += 10;
+            if (score > 0) results.push({ score, moduleName, moduleInfo, apiName, apiInfo });
+        });
+    });
+
+    results.sort((a, b) => b.score - a.score);
+    const topResults = results.slice(0, maxResults);
+
+    if (topResults.length > 0) {
+        let content = `# 搜索结果：${keyword}\n\n找到 ${topResults.length} 个相关 API (共 ${results.length} 个匹配)\n\n---\n\n`;
+        topResults.forEach(({ moduleName, moduleInfo, apiName, apiInfo }) => {
+            content += `## ${moduleName}.${apiName}\n\n**模块**: ${moduleInfo.name}\n\n**描述**: ${apiInfo.description}\n\n**版本**: ${apiInfo.version}\n\n${apiInfo.content}\n\n---\n\n`;
+        });
+        return { content: [{ type: 'text', text: content }] };
+    } else {
+        return { content: [{ type: 'text', text: `未找到包含 "${keyword}" 的内容。` }] };
+    }
+}
+
+/**
+ * 列出 CCDK 模块
+ */
+async function listCcdkModules({ showApis = false }) {
+    const tree = ccdkApiTree;
+    let content = '# CCDK API 模块列表\n\n';
+    Object.entries(tree).forEach(([moduleName, moduleInfo]) => {
+        const apiCount = Object.keys(moduleInfo.apis).length;
+        content += `## ${moduleName} - ${moduleInfo.name}\n\n${moduleInfo.description}\n\n**API 数量**: ${apiCount}\n\n`;
+        if (showApis) {
+            content += '**包含 API**:\n';
+            Object.entries(moduleInfo.apis).forEach(([apiName, apiInfo]) => {
+                content += `- \`${apiName}\`: ${apiInfo.description}\n`;
+            });
+            content += '\n';
+        }
+        content += '---\n\n';
+    });
+    return { content: [{ type: 'text', text: content }] };
+}
+
+module.exports = {
+    getCcdkDocs,
+    searchCcdkDocs,
+    listCcdkModules
+};