cloudcc-cli 2.2.2 → 2.2.4

package/src/mcp/tools/Class Editor Guide/prompt.js

@@ -0,0 +1,468 @@
+/**
+ * EditClass 工具知识库 - 编辑类时需要的核心 API 文档
+ * 从 classes/prompt.js 迁移而来
+ */
+
+/**
+ * 从 CCService 提取 API 文档
+ */
+function extractCCServiceApis() {
+    return {
+        name: 'CCService 数据操作 API',
+        description: '核心服务类，用于数据增删改查和业务逻辑操作',
+        apis: {
+            // 查询方法
+            cquery: {
+                description: '无条件查询所有数据',
+                signature: 'List<CCObject> cquery(String apiName)',
+                example: 'List<CCObject> accounts = cs.cquery("account");',
+                returns: 'CCObject 列表'
+            },
+            cqueryWithCondition: {
+                description: '条件查询数据',
+                signature: 'List<CCObject> cquery(String apiName, String expression)',
+                example: 'List<CCObject> result = cs.cquery("account", "name like \'%销售%\'");',
+                returns: 'CCObject 列表',
+                params: [
+                    { name: 'apiName', type: 'String', desc: '对象 API 名称，如 account, contact 等' },
+                    { name: 'expression', type: 'String', desc: '查询条件，支持 like, =, >, <, >= <= 等操作符' }
+                ]
+            },
+            cqlQuery: {
+                description: 'CQL 条件查询（推荐）',
+                signature: 'List<CCObject> cqlQuery(String apiName, String expression)',
+                example: 'List<CCObject> result = cs.cqlQuery("account", "status = \'active\'");',
+                returns: 'CCObject 列表',
+                note: '性能比 cquery 更优，推荐使用'
+            },
+
+            // 插入方法
+            insert: {
+                description: '新增单条记录',
+                signature: 'ServiceResult insert(CCObject cobj)',
+                example: `CCObject obj = new CCObject("account");
+obj.put("name", "新客户");
+obj.put("type", "1");
+ServiceResult sr = cs.insert(obj);
+String id = sr.get("id"); // 获取新增记录的 ID`,
+                returns: 'ServiceResult 包含新增记录的 ID'
+            },
+            insertBatch: {
+                description: '批量新增记录',
+                signature: 'ServiceResult insert(List<CCObject> datalist)',
+                example: `List<CCObject> list = new ArrayList<>();
+for(int i=0; i<3; i++) {
+    CCObject obj = new CCObject("account");
+    obj.put("name", "客户"+i);
+    list.add(obj);
+}
+ServiceResult sr = cs.insert(list);`,
+                returns: 'ServiceResult 包含所有新增记录的 ID'
+            },
+
+            // 更新方法
+            update: {
+                description: '更新单条记录',
+                signature: 'void update(CCObject cobj)',
+                example: `CCObject obj = new CCObject("account");
+obj.put("id", "existingId");
+obj.put("name", "更新的名称");
+cs.update(obj);`,
+                note: 'CCObject 必须包含 id 字段用于标识更新的记录'
+            },
+
+            // 删除方法
+            delete: {
+                description: '删除记录',
+                signature: 'void delete(CCObject cobj)',
+                example: `CCObject obj = new CCObject("account");
+obj.put("id", "recordId");
+cs.delete(obj);`
+            },
+
+            // Upsert 方法
+            upsert: {
+                description: '新增或更新记录（有 id 则更新，无则新增）',
+                signature: 'ServiceResult upsert(CCObject cobj)',
+                example: `CCObject obj = new CCObject("account");
+obj.put("id", "existingId"); // 存在则更新，不存在则新增
+obj.put("name", "账户名称");
+ServiceResult sr = cs.upsert(obj);`,
+                returns: 'ServiceResult 包含记录的 ID'
+            },
+
+            // 邮件方法
+            sendEmail: {
+                description: '发送邮件',
+                signature: 'String sendEmail(String subject, String htmlBody, String toAddress, String relatedid, String ccaddress, String bccaddress, String attachmentId, String s, String s1)',
+                example: 'cs.sendEmail("邮件主题", "<h1>邮件内容</h1>", "user@example.com", "", "", "", "", "", "");',
+                note: '该方法支持 HTML 格式的邮件内容'
+            }
+        },
+        bestPractices: [
+            '查询时优先使用 cqlQuery，性能更优',
+            '批量操作使用 insertBatch 而非循环调用 insert',
+            '修改数据前建议先查询验证数据存在',
+            '操作后检查 ServiceResult 的返回值确保成功',
+            '大量数据操作建议分批处理以避免超时'
+        ]
+    };
+}
+
+/**
+ * 从 CCObject 提取对象操作文档
+ */
+function extractCCObjectDocs() {
+    return {
+        name: 'CCObject 对象操作',
+        description: 'CloudCC 数据对象，继承自 HashMap<String, Object>',
+        constructors: [
+            {
+                signature: 'CCObject(String ccobj)',
+                desc: '创建指定对象类型的 CCObject',
+                example: `CCObject account = new CCObject("account");`,
+                recommended: true
+            }
+        ],
+        methods: {
+            dataAccess: {
+                items: [
+                    {
+                        name: 'put/get/containsKey/remove/keySet',
+                        desc: '继承自 HashMap 的标准方法',
+                        example: `obj.put("name", "值");
+String name = (String) obj.get("name");`
+                    }
+                ]
+            }
+        },
+        bestPractices: {
+            creation: ['使用 new CCObject("objectApi") 构造方法'],
+            dataManipulation: ['获取字段值时进行类型转换和 null 检查'],
+            withCCService: ['更新前先查询，批量操作使用 List<CCObject>']
+        },
+        commonObjects: [
+            { name: 'account', label: '客户', commonFields: ['id', 'name', 'type', 'owner'] },
+            { name: 'contact', label: '联系人', commonFields: ['id', 'name', 'account', 'email'] },
+            { name: 'opportunity', label: '商机', commonFields: ['id', 'name', 'stage', 'amount'] }
+        ]
+    };
+}
+
+/**
+ * 从 SendEmail 提取邮件发送文档
+ */
+function extractSendEmailDocs() {
+    return {
+        name: 'SendEmail 邮件服务',
+        methods: {
+            sendMailFromSystem: {
+                description: '发送邮件',
+                example: `SendEmail sender = new SendEmail(userInfo);
+sender.sendMailFromSystem(
+    new String[]{"user@example.com"}, 
+    null, null, "主题", "<h1>内容</h1>", false
+);`
+            }
+        }
+    };
+}
+
+/**
+ * 从 TimeUtil 提取时间工具文档
+ */
+function extractTimeUtilDocs() {
+    return {
+        name: 'TimeUtil 时间工具',
+        methods: {
+            getSimpleDateFormat: {
+                example: `SimpleDateFormat sdf = TimeUtil.getSimpleDateFormat("yyyy-MM-dd HH:mm:ss", userInfo);
+String dateStr = sdf.format(new Date());`
+            }
+        }
+    };
+}
+
+/**
+ * 从 UserInfo 提取用户信息文档
+ */
+function extractUserInfoDocs() {
+    return {
+        name: 'UserInfo 用户信息',
+        properties: [
+            { name: 'getUserId()', desc: '获取用户ID' },
+            { name: 'getUserName()', desc: '获取用户名' },
+            { name: 'getRoleId()', desc: '获取角色ID' }
+        ]
+    };
+}
+
+/**
+ * 从 DevLogger 提取日志文档
+ */
+function extractDevLoggerDocs() {
+    return {
+        name: 'DevLogger 开发日志',
+        methods: [
+            { name: 'devLogInfo(String log)', desc: '输出信息日志', example: 'DevLogger.devLogInfo("处理开始");' },
+            { name: 'devLogError(String log)', desc: '输出错误日志', example: 'DevLogger.devLogError("失败");' },
+            { name: 'devLogError(String log, Exception e)', desc: '输出异常', example: 'DevLogger.devLogError("错误", e);' }
+        ]
+    };
+}
+
+/**
+ * 常见编辑需求场景
+ */
+function getEditScenarios() {
+    return [
+        {
+            scenario: '数据查询和更新',
+            example: `List<CCObject> records = cs.cqlQuery("account", "status = 'active'");
+for(CCObject obj : records) {
+    obj.put("lastCheck", new Date());
+    cs.update(obj);
+}`
+        },
+        {
+            scenario: '批量创建',
+            example: `List<CCObject> list = new ArrayList<>();
+for(int i=0; i<10; i++) {
+    CCObject obj = new CCObject("contact");
+    obj.put("name", "联系人"+i);
+    list.add(obj);
+}
+cs.insert(list);`
+        }
+    ];
+}
+
+// 初始化 API 文档
+const editCCServiceApis = extractCCServiceApis();
+const editCCObjectDocs = extractCCObjectDocs();
+const editSendEmailDocs = extractSendEmailDocs();
+const editTimeUtilDocs = extractTimeUtilDocs();
+const editUserInfoDocs = extractUserInfoDocs();
+const editDevLoggerDocs = extractDevLoggerDocs();
+const editScenarios = getEditScenarios();
+
+
+/**
+ * 格式化 API 文档
+ */
+function formatApiDocs(api) {
+    const lines = [`### ${api.name}\n${api.description}\n`];
+
+    for (const [key, method] of Object.entries(api.apis || api.methods || {})) {
+        lines.push(`#### ${method.description}`);
+        lines.push(`\`\`\`java\n${method.example}\n\`\`\``);
+
+        if (method.params) {
+            lines.push('**参数**:');
+            method.params.forEach(p => {
+                lines.push(`- ${p.name} (${p.type}): ${p.desc}`);
+            });
+        }
+        if (method.returns) lines.push(`**返回**: ${method.returns}`);
+        if (method.note) lines.push(`**提示**: ${method.note}`);
+        lines.push('');
+    }
+
+    if (api.bestPractices) {
+        lines.push('### 最佳实践');
+        api.bestPractices.forEach(p => {
+            lines.push(`- ${p}`);
+        });
+    }
+
+    return lines.join('\n');
+}
+
+/**
+ * 生成API类概要（简要信息）
+ */
+function generateApiSummary() {
+    return [
+        '## 📚 可用 API 类',
+        '1. CCService - 数据CRUD (`topic: "ccservice"`)',
+        '2. CCObject - 数据对象 (`topic: "object"`)',
+        '3. SendEmail - 邮件服务 (`topic: "email"`)',
+        '4. TimeUtil - 时间工具 (`topic: "time"`)',
+        '5. UserInfo - 用户信息 (`topic: "user"`)',
+        '6. DevLogger - 日志工具 (`topic: "logger"`)',
+        '7. 场景示例 (`topic: "scenarios"`)'
+    ].join('\n');
+}
+
+/**
+ * 生成概览（包含规范、最佳实践、API概要）
+ */
+function generateOverview() {
+    return [
+        '# CloudCC 类编辑知识库',
+        '',
+        '## 🔴 核心规则',
+        '**所有代码必须写在以下标记之间**：',
+        '```java',
+        '// @SOURCE_CONTENT_START',
+        '// 业务代码',
+        '// @SOURCE_CONTENT_END',
+        '```',
+        '',
+        '## ⚠️ 常见错误',
+        '| 错误 | 正确 |',
+        '|------|------|',
+        '| `DevLogger.error()` | `DevLogger.devLogError()` |',
+        '| `new CCObject()` | `new CCObject("account")` |',
+        '| `obj.get("field")` | `(String) obj.get("field")` |',
+        '',
+        '## ✅ 编码规范与最佳实践',
+        '',
+        '### 数据验证',
+        '- 新增或更新前验证数据的合法性',
+        '- 检查必填字段是否为空',
+        '- 验证数据格式是否正确',
+        '- 检查是否存在重复数据',
+        '',
+        '### 错误处理',
+        '- 使用 try-catch 捕获异常',
+        '- 使用 DevLogger 记录错误信息',
+        '- 对关键操作进行日志记录',
+        '- 返回有意义的错误提示',
+        '',
+        '### 性能优化',
+        '- 使用批量操作替代循环调用',
+        '- 避免在循环中进行数据库查询',
+        '- 大数据量操作时分批处理',
+        '- 优先使用条件查询减少数据传输',
+        '- 使用 cqlQuery 替代 cquery（性能更优）',
+        '',
+        '### 安全规范',
+        '- 验证用户权限和数据访问权限',
+        '- 不要在日志中输出敏感数据',
+        '- 对外部输入进行验证和清理',
+        '- 使用 UserInfo 进行权限检查',
+        '',
+        generateApiSummary(),
+        ''
+    ].join('\n');
+}
+
+/**
+ * 生成 CCService 指南
+ */
+function generateCCServiceGuide() {
+    return formatApiDocs(editCCServiceApis);
+}
+
+/**
+ * 生成 CCObject 指南
+ */
+function generateCCObjectGuide() {
+    const obj = editCCObjectDocs;
+    const lines = [`## ${obj.name}\n${obj.description}\n`];
+    obj.constructors.forEach(c => lines.push(`\`\`\`java\n${c.example}\n\`\`\``));
+    if (obj.methods?.dataAccess?.items) {
+        obj.methods.dataAccess.items.forEach(item => {
+            lines.push(`**${item.name}**: ${item.desc}\n\`\`\`java\n${item.example}\n\`\`\``);
+        });
+    }
+    return lines.join('\n');
+}
+
+/**
+ * 生成邮件服务指南
+ */
+function generateEmailGuide() {
+    return formatApiDocs({ ...editSendEmailDocs, apis: editSendEmailDocs.methods });
+}
+
+/**
+ * 生成时间工具指南
+ */
+function generateTimeUtilGuide() {
+    const lines = [`## ${editTimeUtilDocs.name}\n`];
+    for (const [key, method] of Object.entries(editTimeUtilDocs.methods)) {
+        lines.push(`\`\`\`java\n${method.example}\n\`\`\``);
+    }
+    return lines.join('\n');
+}
+
+/**
+ * 生成用户信息指南
+ */
+function generateUserInfoGuide() {
+    const lines = [`## ${editUserInfoDocs.name}\n`];
+    editUserInfoDocs.properties.forEach(prop => {
+        lines.push(`- \`${prop.name}\`: ${prop.desc}`);
+    });
+    return lines.join('\n');
+}
+
+/**
+ * 生成日志输出指南
+ */
+function generateLoggerGuide() {
+    const lines = [`## ${editDevLoggerDocs.name}\n`];
+    editDevLoggerDocs.methods.forEach(method => {
+        lines.push(`**${method.name}**: ${method.desc}\n\`\`\`java\n${method.example}\n\`\`\``);
+    });
+    return lines.join('\n');
+}
+
+/**
+ * 生成常见场景
+ */
+function generateScenariosGuide() {
+    const lines = ['## 常见场景\n'];
+    editScenarios.forEach(s => {
+        lines.push(`### ${s.scenario}\n\`\`\`java\n${s.example}\n\`\`\`\n`);
+    });
+    return lines.join('\n');
+}
+
+
+/**
+ * 获取快速 API 参考（用于详细API主题）
+ */
+function getQuickApiReference() {
+    return `\n---\n💡 提示：代码必须写在 \`@SOURCE_CONTENT_START\` 和 \`@SOURCE_CONTENT_END\` 之间`;
+}
+
+
+/**
+ * 获取指定主题的编辑文档
+ */
+function getEditGuide(topic) {
+    const guides = {
+        overview: generateOverview,        // 规范 + 最佳实践 + API概要（默认）
+        ccservice: generateCCServiceGuide, // CCService 详细API
+        object: generateCCObjectGuide,     // CCObject 详细API
+        email: generateEmailGuide,         // SendEmail 详细API
+        time: generateTimeUtilGuide,       // TimeUtil 详细API
+        user: generateUserInfoGuide,       // UserInfo 详细API
+        logger: generateLoggerGuide,       // DevLogger 详细API
+        scenarios: generateScenariosGuide  // 常见场景示例
+    };
+
+    const result = guides[topic] ? guides[topic]() : `✗ 未知的主题: ${topic}\n\n支持的主题: ${Object.keys(guides).join(', ')}`;
+
+    // overview 已经包含了所有规范和最佳实践，其他主题只添加简化的 API 标准提示
+    if (topic !== 'overview' && result.includes('```java')) {
+        return result + '\n\n---\n\n' + getQuickApiReference();
+    }
+
+    return result;
+}
+
+module.exports = {
+    getEditGuide,
+    generateOverview,
+    generateCCServiceGuide,
+    generateCCObjectGuide,
+    generateEmailGuide,
+    generateTimeUtilGuide,
+    generateUserInfoGuide,
+    generateLoggerGuide,
+    generateScenariosGuide
+};

package/src/mcp/tools/Class List Retriever/handler.js

@@ -0,0 +1,36 @@
+/**
+ * Classes 工具处理器
+ * 提供自定义类的查询功能
+ */
+
+const getClassModule = require('../../../classes/get');
+
+/**
+ * 获取类列表
+ */
+async function listClasses({ projectPath = process.cwd() }) {
+    try {
+
+        let classList = await getClassModule('', projectPath, true);
+
+        if (!classList || classList.length === 0) {
+            return { content: [{ type: 'text', text: '未找到任何类' }] };
+        }
+
+        let result = `## 类列表\n\n找到 ${classList.length} 个类\n\n`;
+
+        classList.forEach((item, index) => {
+            result += `### ${index + 1}. ${item.name || item.apiname}\n`;
+            result += `- **ID**: ${item.id}\n`;
+            result += `- **API名称**: ${item.apiname || 'N/A'}\n\n`;
+        });
+
+        return { content: [{ type: 'text', text: result }] };
+    } catch (error) {
+        return { content: [{ type: 'text', text: `✗ 查询失败: ${error.message}` }] };
+    }
+}
+
+module.exports = {
+    listClasses
+};

package/src/mcp/tools/Class Publisher/handler.js

@@ -0,0 +1,29 @@
+/**
+ * Class Publisher 工具处理器
+ * 发布自定义类到服务器
+ */
+
+const publishClassModule = require('../../../classes/publish');
+
+/**
+ * 发布类到服务器
+ */
+async function publishClass({ className, projectPath = process.cwd() }) {
+    try {
+        const originalCwd = process.cwd();
+        process.chdir(projectPath);
+
+        try {
+            await publishClassModule(className);
+            return { content: [{ type: 'text', text: `✓ 发布成功！类 ${className} 已发布到服务器` }] };
+        } finally {
+            process.chdir(originalCwd);
+        }
+    } catch (error) {
+        return { content: [{ type: 'text', text: `✗ 发布失败: ${error.message}` }] };
+    }
+}
+
+module.exports = {
+    publishClass
+};

package/src/mcp/tools/Class Publisher/prompt.js

@@ -0,0 +1,40 @@
+/**
+ * Class Publisher 工具知识库
+ * 提供类发布指南和规范
+ */
+
+module.exports = {
+    description: '发布本地自定义类到服务器',
+    parameters: {
+        className: {
+            type: 'string',
+            required: true,
+            description: '要发布的类名'
+        },
+        projectPath: {
+            type: 'string',
+            required: false,
+            description: '项目路径，默认为当前工作目录'
+        }
+    },
+    publishProcess: [
+        '1. 验证本地类文件是否存在和有效',
+        '2. 检查config.json配置文件',
+        '3. 提取 @SOURCE_CONTENT_START 和 @SOURCE_CONTENT_END 之间的源码',
+        '4. 上传源码到服务器',
+        '5. 更新本地config.json中的服务器ID'
+    ],
+    requirements: [
+        '类必须已本地创建，拥有完整的classes/{ClassName}目录',
+        '必须包含{ClassName}.java主类文件',
+        '必须包含config.json配置文件',
+        '源码必须位于@SOURCE_CONTENT_START和@SOURCE_CONTENT_END之间',
+        '必须有效的网络连接和服务器权限'
+    ],
+    bestPractices: [
+        '发布前进行本地测试和编译检查',
+        '确保代码注释清晰，便于后续维护',
+        '版本号应遵循语义化版本规范',
+        '发布成功后备份config.json文件'
+    ]
+};

package/src/mcp/tools/Class Puller/handler.js

@@ -0,0 +1,86 @@
+/**
+ * Class Puller 工具处理器
+ * 从服务器拉取自定义类
+ */
+
+const fs = require('fs');
+const path = require('path');
+const getClassModule = require('../../../classes/get');
+const pullClassModule = require('../../../classes/pull');
+const pullListModule = require('../../../classes/pullList');
+
+/**
+ * 从服务器拉取类
+ */
+async function pullClass({ className, projectPath = process.cwd() }) {
+    try {
+        const classPath = path.join(projectPath, `classes/${className}`);
+        const configPath = path.join(classPath, 'config.json');
+
+        // 检查本地是否存在该类
+        if (!fs.existsSync(configPath)) {
+            // 本地不存在，查询服务器
+            try {
+                const queryString = encodeURI(JSON.stringify({
+                    name: className
+                }));
+                const classList = await getClassModule(queryString, projectPath, true);
+
+                if (!classList || classList.length === 0) {
+                    return {
+                        content: [{
+                            type: 'text',
+                            text: `✗ 拉取失败: 服务器上不存在类 ${className}`
+                        }]
+                    };
+                }
+
+                // 找到匹配的类
+                const targetClass = classList.find(item => item.name === className || item.apiname === className);
+                if (!targetClass) {
+                    return {
+                        content: [{
+                            type: 'text',
+                            text: `✗ 拉取失败: 服务器上未找到类 ${className}`
+                        }]
+                    };
+                }
+
+                // 使用 ID 从服务器拉取并在本地创建
+                const originalCwd = process.cwd();
+                process.chdir(projectPath);
+
+                try {
+                    await pullListModule(targetClass.id, projectPath, true);
+                    return {
+                        content: [{
+                            type: 'text',
+                            text: `✓ 拉取成功！已从服务器拉取类 ${className} 并在本地创建\n\n本地路径: classes/${className}/`
+                        }]
+                    };
+                } finally {
+                    process.chdir(originalCwd);
+                }
+            } catch (error) {
+                return { content: [{ type: 'text', text: `✗ 拉取失败: ${error.message}` }] };
+            }
+        }
+
+        // 本地存在，直接更新
+        const originalCwd = process.cwd();
+        process.chdir(projectPath);
+
+        try {
+            await pullClassModule(className);
+            return { content: [{ type: 'text', text: `✓ 拉取成功！本地文件已更新: classes/${className}/${className}.java` }] };
+        } finally {
+            process.chdir(originalCwd);
+        }
+    } catch (error) {
+        return { content: [{ type: 'text', text: `✗ 拉取失败: ${error.message}` }] };
+    }
+}
+
+module.exports = {
+    pullClass
+};