cloudcc-cli 2.2.2 → 2.2.4

package/src/mcp/tools/Dev Environment Creator/prompt.js

@@ -0,0 +1,273 @@
+/**
+ * CloudCC 开发环境搭建知识库
+ * 
+ * 自动生成的文件，请勿手动修改
+ * 生成时间: 2025-12-04T11:10:21.433Z
+ * 来源: https://help.cloudcc.cn/devlearn01/huan-jing-da-jian/
+ */
+
+const metadata = {
+  "title": "CloudCC 开发环境搭建指南",
+  "description": "详细的开发环境配置教程，涵盖 Node.js、npm、VS Code 等必要工具的安装与配置",
+  "sourceUrl": "https://help.cloudcc.cn/devlearn01/huan-jing-da-jian/",
+  "generatedAt": "2025-12-04T11:10:21.433Z",
+  "version": "1.0.0"
+};
+
+const steps = [
+  {
+    "number": 1,
+    "title": "安装node",
+    "description": "版本检查，打开控制台，输入以下命令：",
+    "content": "<pre><code>下载地址 https://nodejs.org/download/release/v20.19.5/\n\n推荐使用：nvm node多版本管理工具</code></pre>\n<p>版本检查，打开控制台，输入以下命令：</p>\n<pre><code>node -v</code></pre>",
+    "keywords": [
+      "node"
+    ],
+    "commands": [
+      {
+        "command": "下载地址 https://nodejs.org/download/release/v20.19.5/\n\n推荐使用：nvm node多版本管理工具",
+        "platform": "all",
+        "description": "执行命令"
+      },
+      {
+        "command": "node -v",
+        "platform": "all",
+        "description": "检查 Node.js 版本"
+      }
+    ],
+    "references": [],
+    "difficulty": "medium",
+    "estimatedTime": 10
+  },
+  {
+    "number": 2,
+    "title": "切换npm源",
+    "description": "为了加速安装依赖，将npm源地址切换为阿里源，打开控制台，输入以下命令： 检查是否设置成功，在控制台中输入以下命令：",
+    "content": "<p>为了加速安装依赖，将npm源地址切换为阿里源，打开控制台，输入以下命令：</p>\n<pre><code>npm config set registry https://registry.npmmirror.com</code></pre>\n<p>检查是否设置成功，在控制台中输入以下命令：</p>\n<pre><code>npm config get registry</code></pre>",
+    "keywords": [
+      "npm",
+      "registry"
+    ],
+    "commands": [
+      {
+        "command": "npm config set registry https://registry.npmmirror.com",
+        "platform": "all",
+        "description": "设置 npm 源地址"
+      },
+      {
+        "command": "npm config get registry",
+        "platform": "all",
+        "description": "验证 npm 源设置"
+      }
+    ],
+    "references": [],
+    "difficulty": "easy",
+    "estimatedTime": 5
+  },
+  {
+    "number": 3,
+    "title": "安装全局依赖",
+    "description": "检查是否安装成功，控制台输入以下命令： 检查是否安装成功，控制台输入以下命令：",
+    "content": "<pre><code>npm install -g cloudcc-cli</code></pre>\n<p>检查是否安装成功，控制台输入以下命令：</p>\n<pre><code>npm ls -g --depth=0</code></pre>\n<pre><code>sudo npm install -g cloudcc-cli</code></pre>\n<p>检查是否安装成功，控制台输入以下命令：</p>\n<pre><code>sudo npm ls -g --depth=0</code></pre>",
+    "keywords": [
+      "dependencies"
+    ],
+    "commands": [
+      {
+        "command": "npm install -g cloudcc-cli",
+        "platform": "all",
+        "description": "安装全局依赖包"
+      },
+      {
+        "command": "npm ls -g --depth=0",
+        "platform": "all",
+        "description": "检查全局安装的包"
+      },
+      {
+        "command": "sudo npm install -g cloudcc-cli",
+        "platform": "macos",
+        "description": "安装全局依赖包"
+      },
+      {
+        "command": "sudo npm ls -g --depth=0",
+        "platform": "macos",
+        "description": "检查全局安装的包"
+      }
+    ],
+    "references": [],
+    "difficulty": "medium",
+    "estimatedTime": 15,
+    "subSteps": [
+      {
+        "title": "3.1 window用户：打开控制台输入以下命令",
+        "description": "",
+        "commands": [],
+        "notes": []
+      },
+      {
+        "title": "3.2 MacOS用户：打开控制台输入以下命令",
+        "description": "",
+        "commands": [],
+        "notes": []
+      }
+    ]
+  },
+  {
+    "number": 4,
+    "title": "安装vs-code",
+    "description": "安装vs-code",
+    "content": "<pre><code>下载地址：https://code.visualstudio.com/download</code></pre>",
+    "keywords": [
+      "vscode"
+    ],
+    "commands": [
+      {
+        "command": "下载地址：https://code.visualstudio.com/download",
+        "platform": "all",
+        "description": "执行命令"
+      }
+    ],
+    "references": [],
+    "difficulty": "medium",
+    "estimatedTime": 5
+  },
+  {
+    "number": 5,
+    "title": "安装vs-code插件：CloudCC",
+    "description": "安装vs-code插件：CloudCC",
+    "content": "<ul><li>打开安装完成的vs code，点击扩展图标</li></ul>\n<ul><li>输入CloudCC，选择安装</li></ul>",
+    "keywords": [
+      "vscode",
+      "plugin"
+    ],
+    "commands": [],
+    "references": [],
+    "difficulty": "easy",
+    "estimatedTime": 5
+  },
+  {
+    "number": 6,
+    "title": "创建模版项目",
+    "description": "打开控制台，进入您的开发目录，比如Docments，运行创建项目命令： 浏览器访问：http://localhost:8080/，可以看到以下页面",
+    "content": "<p>打开控制台，进入您的开发目录，比如Docments，运行创建项目命令：</p>\n<pre><code>cc create project demo1</code></pre>\n<ul><li>使用vs code打开项目</li></ul>\n<ul><li>选择菜单里中的：终端——新建终端</li></ul>\n<ul><li>安装依赖：在打开的终端里输入以下命令：</li></ul>\n<pre><code>npm i</code></pre>\n<ul><li>安装完成后，运行项目，在终端中执行命令</li></ul>\n<pre><code>npm run serve</code></pre>\n<p>浏览器访问：http://localhost:8080/，可以看到以下页面</p>",
+    "keywords": [],
+    "commands": [
+      {
+        "command": "cc create project demo1",
+        "platform": "all",
+        "description": "执行命令"
+      },
+      {
+        "command": "npm i",
+        "platform": "all",
+        "description": "执行命令"
+      },
+      {
+        "command": "npm run serve",
+        "platform": "all",
+        "description": "执行命令"
+      }
+    ],
+    "references": [],
+    "difficulty": "medium",
+    "estimatedTime": 5
+  }
+  ,
+  {
+    "number": 7,
+    "title": "配置开发者密钥",
+    "description": "环境搭建完成后，需要配置开发者密钥以便进行 API 调用和插件开发。可调用MCP工具 `get_developer_key_setup_guide` 获取详细的密钥配置步骤。",
+    "content": "<p>环境搭建完成后，下一步是配置开发者密钥（Developer Key）。建议调用工具 <code>get_developer_key_setup_guide</code> 来获取交互式的引导和具体命令。</p>\n<pre><code>示例：请运行工具 get_developer_key_setup_guide 来查看并完成密钥配置。</code></pre>",
+    "keywords": [
+      "developer key",
+      "密钥",
+      "key",
+      "开发者密钥"
+    ],
+    "commands": [],
+    "references": [],
+    "difficulty": "easy",
+    "estimatedTime": 5
+  }
+];
+
+const guide = {
+  ...metadata,
+  steps,
+};
+
+/**
+ * 按关键词搜索步骤
+ */
+function searchSteps(keyword) {
+  const lower = keyword.toLowerCase();
+  return guide.steps.filter(step =>
+    step.title.toLowerCase().includes(lower) ||
+    step.description.toLowerCase().includes(lower) ||
+    step.keywords.some(k => k.toLowerCase().includes(lower))
+  );
+}
+
+/**
+ * 按平台获取命令
+ */
+function getCommandsByPlatform(platform) {
+  const commands = [];
+  guide.steps.forEach(step => {
+    step.commands.forEach(cmd => {
+      if (cmd.platform === 'all' || cmd.platform === platform) {
+        commands.push(cmd);
+      }
+    });
+  });
+  return commands;
+}
+
+/**
+ * 按步骤号获取步骤详情
+ */
+function getStep(stepNumber) {
+  return guide.steps.find(s => s.number === stepNumber);
+}
+
+/**
+ * 获取所有步骤
+ */
+function getAllSteps() {
+  return guide.steps;
+}
+
+/**
+ * 获取指定难度的步骤
+ */
+function getStepsByDifficulty(difficulty) {
+  return guide.steps.filter(s => s.difficulty === difficulty);
+}
+
+/**
+ * 获取所有参考链接
+ */
+function getAllReferences() {
+  const refs = [];
+  guide.steps.forEach(step => {
+    refs.push(...step.references);
+  });
+  return refs;
+}
+
+/**
+ * 按分类获取参考链接
+ */
+function getReferencesByCategory(category) {
+  return getAllReferences().filter(r => r.category === category);
+}
+
+// 导出所有函数和对象
+module.exports = guide;
+module.exports.searchSteps = searchSteps;
+module.exports.getCommandsByPlatform = getCommandsByPlatform;
+module.exports.getStep = getStep;
+module.exports.getAllSteps = getAllSteps;
+module.exports.getStepsByDifficulty = getStepsByDifficulty;
+module.exports.getAllReferences = getAllReferences;
+module.exports.getReferencesByCategory = getReferencesByCategory;

package/src/mcp/tools/Dev Environment Validator/handler.js

@@ -0,0 +1,88 @@
+/**
+ * Dev Environment Validator 工具处理器
+ * 读取同目录下的 prompt.js（知识库），并根据请求参数返回格式化的文本内容
+ */
+
+const prompt = require('./prompt.js');
+const { searchSteps, getCommandsByPlatform, getStep, getAllSteps } = require('./prompt.js');
+
+/**
+ * 获取开发环境验证提示
+ * 支持参数：step, search, difficulty, platform, command
+ * 返回结构与其他 MCP 工具一致：{ content: [{ type: 'text', text: '...' }] }
+ */
+async function getDevEnvSetup(params = {}) {
+  const { step, search, difficulty, platform, command } = params;
+  try {
+    if (search) {
+      const results = searchSteps(search);
+      if (!results || results.length === 0) {
+        return { content: [{ type: 'text', text: `未找到包含 "${search}" 的步骤。` }] };
+      }
+      let content = `# 搜索结果: "${search}"\n\n找到 ${results.length} 个相关步骤\n\n`;
+      results.forEach(s => {
+        content += `## ${s.number}. ${s.title}\n**难度**: ${s.difficulty}\n\n`;
+      });
+      return { content: [{ type: 'text', text: content }] };
+    }
+
+    if (difficulty) {
+      const results = prompt.steps.filter(s => s.difficulty === difficulty);
+      let content = `# ${difficulty} 难度步骤 (共 ${results.length} 个)\n\n`;
+      results.forEach(s => {
+        content += `${s.number}. ${s.title}\n`;
+      });
+      return { content: [{ type: 'text', text: content }] };
+    }
+
+    if (platform) {
+      const commands = getCommandsByPlatform(platform);
+      let content = `# ${platform} 平台命令 (共 ${commands.length} 个)\n\n`;
+      commands.forEach((cmd, idx) => {
+        content += `${idx + 1}. ${cmd.description}\n\n\`\`\`bash\n${cmd.command}\n\`\`\`\n\n`;
+      });
+      return { content: [{ type: 'text', text: content }] };
+    }
+
+    if (step) {
+      const targetStep = getStep(step);
+      if (!targetStep) {
+        return { content: [{ type: 'text', text: `无效的步骤编号 ${step}` }] };
+      }
+      let content = `# 步骤 ${targetStep.number}: ${targetStep.title}\n\n**难度**: ${targetStep.difficulty}\n**耗时**: ${targetStep.estimatedTime} 分钟\n\n${targetStep.description}`;
+      if (targetStep.commands && targetStep.commands.length > 0) {
+        content += `\n\n## 命令 (共 ${targetStep.commands.length} 个)\n\n`;
+        targetStep.commands.forEach((cmd, idx) => {
+          content += `${idx + 1}. ${cmd.description}\n\`\`\`bash\n${cmd.command}\n\`\`\`\n\n`;
+        });
+      }
+      return { content: [{ type: 'text', text: content }] };
+    }
+
+    if (command) {
+      const steps = getAllSteps();
+      let content = `# 所有命令 (共 ${steps.reduce((sum, s) => sum + (s.commands ? s.commands.length : 0), 0)} 个)\n\n`;
+      steps.forEach(s => {
+        if (s.commands && s.commands.length > 0) {
+          content += `## ${s.title}\n`;
+          s.commands.forEach(cmd => {
+            content += `\`\`\`bash\n${cmd.command}\n\`\`\`\n`;
+          });
+          content += `\n`;
+        }
+      });
+      return { content: [{ type: 'text', text: content }] };
+    }
+
+    // 默认概览
+    const allSteps = getAllSteps();
+    let content = `# ${prompt.title}\n\n${prompt.description}\n\n**版本**: ${prompt.version}\n**步骤数**: ${allSteps.length}`;
+    return { content: [{ type: 'text', text: content }] };
+  } catch (error) {
+    return { content: [{ type: 'text', text: `错误: ${error.message}` }] };
+  }
+}
+
+module.exports = {
+  getDevEnvSetup
+};

package/src/mcp/tools/Dev Environment Validator/prompt.js

@@ -0,0 +1,193 @@
+/**
+ * 开发环境验证提示词
+ *
+ * 自动生成的文件，请勿手动修改（可覆盖）
+ * 生成时间: 2025-12-11T00:00:00.000Z
+ */
+
+const metadata = {
+    title: "开发环境检查 - CloudCC",
+    description: "在开始使用 cloudcc-cli 之前的本地开发环境检查提示",
+    generatedAt: "2025-12-11T00:00:00.000Z",
+    version: "1.0.0"
+};
+
+const steps = [
+    {
+        number: 1,
+        title: "安装 Node.js",
+        description: "本地需要安装 Node.js。推荐使用版本 v20.19.5。",
+        content: "<p>请确保本地安装了 Node.js，推荐使用 <strong>v20.19.5</strong> 以保证与项目依赖兼容。</p>\n<pre><code>下载地址: https://nodejs.org/download/release/v20.19.5/\n# 或使用 nvm 安装并切换版本（推荐）\nnvm install 20.19.5\nnvm use 20.19.5</code></pre>",
+        keywords: ["node", "nodejs", "v20.19.5"],
+        commands: [
+            {
+                command: "node -v",
+                platform: "all",
+                description: "检查已安装的 Node.js 版本"
+            }
+        ],
+        difficulty: "easy",
+        estimatedTime: 5
+    },
+    {
+        number: 2,
+        title: "切换 npm 源以加速安装",
+        description: "建议将 npm 源切换为国内镜像以加速依赖安装。",
+        content: "<p>将 npm 源切换到淘宝/npmmirror 镜像可以显著加快包安装速度：</p>\n<pre><code>npm config set registry https://registry.npmmirror.com\n# 验证当前 registry 设置\nnpm config get registry</code></pre>",
+        keywords: ["npm", "registry", "npmmirror"],
+        commands: [
+            {
+                command: "npm config set registry https://registry.npmmirror.com",
+                platform: "all",
+                description: "设置 npm registry 为 npmmirror"
+            },
+            {
+                command: "npm config get registry",
+                platform: "all",
+                description: "验证当前 npm registry"
+            }
+        ],
+        difficulty: "easy",
+        estimatedTime: 2
+    },
+    {
+        number: 3,
+        title: "全局安装 cloudcc-cli 脚手架",
+        description: "安装并验证全局可用的 `cloudcc-cli` 命令。",
+        content: "<p>通过 npm 全局安装 cloudcc-cli，以便在命令行中使用相关脚手架命令：</p>\n<pre><code>npm install -g cloudcc-cli\n# 如遇权限问题（macOS），可使用 sudo 或配置 npm 全局安装路径\nsudo npm install -g cloudcc-cli\n# 验证安装是否成功\ncloudcc --version || cc --version</code></pre>",
+        keywords: ["cloudcc-cli", "global", "npm"],
+        commands: [
+            {
+                command: "npm install -g cloudcc-cli",
+                platform: "all",
+                description: "全局安装 cloudcc-cli"
+            },
+            {
+                command: "npm ls -g --depth=0",
+                platform: "all",
+                description: "查看已安装的全局包，确认 cloudcc-cli 是否存在"
+            }
+        ],
+        difficulty: "easy",
+        estimatedTime: 5
+    }
+    ,
+    {
+        number: 4,
+        title: "检查 Java 开发环境（建议 JDK 17）",
+        description: "如果你的项目或后端组件使用 Java，需要在本机安装并配置 JDK。推荐使用 JDK 17（LTS）以获得最佳兼容性与长期支持。",
+        content: "<p>请检查本地是否安装 Java（JDK），并尽量使用 <strong>JDK 17</strong>。</p>\n<pre><code># 检查 Java 运行时版本\njava -version\n# 检查 Java 编译器版本\njavac -version</code></pre>\n<p>在 macOS 上，推荐通过 Homebrew 或 SDKMAN 安装 JDK 17：</p>\n<pre><code># Homebrew 安装（macOS）\nbrew install openjdk@17\n# 然后按提示将路径加入到环境变量，例如：\n# sudo ln -sfn /usr/local/opt/openjdk@17/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk-17.jdk\n# 或者使用 SDKMAN（跨平台）\ncurl -s \"https://get.sdkman.io\" | bash\nsource \"$HOME/.sdkman/bin/sdkman-init.sh\"\nsdk install java 17.0.##-open\n</code></pre>",
+        keywords: ["java", "jdk", "jdk17", "java17"],
+        commands: [
+            {
+                command: "java -version",
+                platform: "all",
+                description: "检查 Java 运行时版本"
+            },
+            {
+                command: "javac -version",
+                platform: "all",
+                description: "检查 Java 编译器版本"
+            },
+            {
+                command: "brew install openjdk@17",
+                platform: "macos",
+                description: "在 macOS 上通过 Homebrew 安装 JDK 17（如已安装 Homebrew）"
+            }
+        ],
+        references: [],
+        difficulty: "medium",
+        estimatedTime: 10
+    },
+    {
+        number: 5,
+        title: "检查 VS Code 及必要扩展",
+        description: "如果安装了 VS Code，需要安装 CloudCC 和 Extension Pack for Java 两个扩展以支持 CloudCC 开发和 Java 开发。",
+        content: "<p>请检查本地是否安装了 <strong>Visual Studio Code</strong>，以及是否已安装以下两个扩展：</p>\n<ul><li><strong>CloudCC</strong> - 用于 CloudCC 平台开发支持</li><li><strong>Extension Pack for Java</strong> - 微软官方 Java 开发工具集，包含 Language Support for Java、Debugger for Java 等</li></ul>\n<p>安装 VS Code 扩展的方式：</p>\n<ol><li>打开 VS Code，点击左侧的<strong>扩展</strong>图标（或按 Ctrl+Shift+X / Cmd+Shift+X）</li><li>在搜索框中分别搜索 \"CloudCC\" 和 \"Extension Pack for Java\"</li><li>点击 \"安装\" 按钮</li></ol>\n<p>或使用命令行安装：</p>\n<pre><code># 安装 CloudCC 扩展\ncode --install-extension cloudcc.cloudcc\n# 安装 Extension Pack for Java\ncode --install-extension vscjava.vscode-java-pack</code></pre>",
+        keywords: ["vscode", "vs code", "extension", "cloudcc", "java"],
+        commands: [
+            {
+                command: "code --version",
+                platform: "all",
+                description: "检查 VS Code 是否已安装"
+            },
+            {
+                command: "code --install-extension cloudcc.cloudcc",
+                platform: "all",
+                description: "安装 CloudCC 扩展"
+            },
+            {
+                command: "code --install-extension vscjava.vscode-java-pack",
+                platform: "all",
+                description: "安装 Extension Pack for Java"
+            }
+        ],
+        references: [],
+        difficulty: "easy",
+        estimatedTime: 5
+    }
+];
+
+const guide = {
+    ...metadata,
+    steps,
+};
+
+/**
+ * 在步骤中按关键词搜索（大小写不敏感）。
+ *
+ * @param {string} keyword - 要搜索的关键词，会被转为小写再匹配。
+ * @returns {Array<Object>} 匹配到的步骤数组，每项为 steps 中的 step 对象。
+ */
+function searchSteps(keyword) {
+    const lower = keyword.toLowerCase();
+    return guide.steps.filter(step =>
+        step.title.toLowerCase().includes(lower) ||
+        step.description.toLowerCase().includes(lower) ||
+        step.keywords.some(k => k.toLowerCase().includes(lower))
+    );
+}
+
+/**
+ * 按平台收集可执行命令列表。
+ *
+ * @param {string} platform - 目标平台标识（例如 'all', 'macos', 'windows' 等）。
+ * @returns {Array<Object>} 命令对象数组，每个对象包含 `command`, `platform`, `description`。
+ */
+function getCommandsByPlatform(platform) {
+    const commands = [];
+    guide.steps.forEach(step => {
+        step.commands.forEach(cmd => {
+            if (cmd.platform === 'all' || cmd.platform === platform) {
+                commands.push(cmd);
+            }
+        });
+    });
+    return commands;
+}
+
+/**
+ * 根据步骤号获取单个步骤详情。
+ *
+ * @param {number} stepNumber - 步骤编号（整数）。
+ * @returns {Object|undefined} 匹配的步骤对象，未找到时返回 undefined。
+ */
+function getStep(stepNumber) {
+    return guide.steps.find(s => s.number === stepNumber);
+}
+
+/**
+ * 获取所有步骤列表。
+ *
+ * @returns {Array<Object>} 当前 guide 中定义的全部步骤数组。
+ */
+function getAllSteps() {
+    return guide.steps;
+}
+
+module.exports = guide;
+module.exports.searchSteps = searchSteps;
+module.exports.getCommandsByPlatform = getCommandsByPlatform;
+module.exports.getStep = getStep;
+module.exports.getAllSteps = getAllSteps;
+