mcp-probe-kit 1.4.0 → 1.7.0

package/build/tools/start_doc.js

@@ -0,0 +1,190 @@
+/**
+ * start_doc 智能编排工具
+ *
+ * 场景：文档生成
+ * 编排：[检查上下文] → gendoc → genreadme → genapi
+ */
+const PROMPT_TEMPLATE = `# 📖 文档生成编排指南
+
+## 🎯 目标
+
+为项目/代码生成完整的文档
+
+**输入内容**:
+\`\`\`
+{code}
+\`\`\`
+
+---
+
+## 📋 步骤 0: 项目上下文（自动处理）
+
+**操作**:
+1. 检查 \`docs/project-context.md\` 是否存在
+2. **如果不存在**：
+   - 调用 \`init_project_context\` 工具
+   - 等待生成完成
+3. **读取** \`docs/project-context.md\` 内容
+4. 了解项目的文档风格、技术栈
+
+---
+
+## 📝 步骤 1: 生成代码注释
+
+**调用工具**: \`gendoc\`
+
+**参数**:
+\`\`\`json
+{
+  "code": "[代码内容]",
+  "style": "{style}",
+  "lang": "{lang}"
+}
+\`\`\`
+
+**生成内容**:
+- 函数/方法注释
+- 参数说明
+- 返回值说明
+- 使用示例
+
+**产出**: 带注释的代码
+
+---
+
+## 📄 步骤 2: 生成 README
+
+**调用工具**: \`genreadme\`
+
+**参数**:
+\`\`\`json
+{
+  "project_info": "[项目信息或代码]",
+  "style": "standard"
+}
+\`\`\`
+
+**生成内容**:
+- 项目简介
+- 功能特性
+- 安装使用
+- API 说明
+- 贡献指南
+
+**产出**: README.md
+
+---
+
+## 🔌 步骤 3: 生成 API 文档（如适用）
+
+**调用工具**: \`genapi\`
+
+**参数**:
+\`\`\`json
+{
+  "code": "[API 相关代码]",
+  "format": "markdown"
+}
+\`\`\`
+
+**生成内容**:
+- API 端点列表
+- 请求/响应格式
+- 参数说明
+
+**产出**: API 文档
+
+---
+
+## ✅ 完成检查
+
+- [ ] 项目上下文已读取
+- [ ] 代码注释已生成
+- [ ] README 已生成
+- [ ] API 文档已生成（如适用）
+
+---
+
+## 📊 输出汇总
+
+完成后，向用户提供：
+
+### 1. 代码注释
+
+\`\`\`typescript
+/**
+ * [函数描述]
+ * @param {Type} param - [参数说明]
+ * @returns {Type} [返回值说明]
+ * @example
+ * [使用示例]
+ */
+\`\`\`
+
+### 2. README.md
+
+\`\`\`markdown
+# 项目名称
+
+## 简介
+...
+
+## 功能特性
+...
+
+## 快速开始
+...
+
+## API 文档
+...
+
+## 贡献指南
+...
+
+## 许可证
+...
+\`\`\`
+
+### 3. API 文档（如适用）
+
+\`\`\`markdown
+## API 参考
+...
+\`\`\`
+
+### 4. 文档清单
+
+| 文档 | 状态 | 位置 |
+|------|------|------|
+| 代码注释 | ✅ | 源代码中 |
+| README | ✅ | README.md |
+| API 文档 | ✅/- | docs/api.md |
+
+---
+
+*编排工具: MCP Probe Kit - start_doc*
+`;
+export async function startDoc(args) {
+    try {
+        const code = args?.code || args?.project_info;
+        if (!code) {
+            throw new Error("缺少必填参数: code 或 project_info");
+        }
+        const style = args?.style || "jsdoc";
+        const lang = args?.lang || "zh";
+        const guide = PROMPT_TEMPLATE
+            .replace(/{code}/g, code)
+            .replace(/{style}/g, style)
+            .replace(/{lang}/g, lang);
+        return {
+            content: [{ type: "text", text: guide }],
+        };
+    }
+    catch (error) {
+        const errorMsg = error instanceof Error ? error.message : String(error);
+        return {
+            content: [{ type: "text", text: `❌ 编排执行失败: ${errorMsg}` }],
+            isError: true,
+        };
+    }
+}

package/build/tools/start_feature.d.ts

@@ -0,0 +1,19 @@
+/**
+ * start_feature 智能编排工具
+ *
+ * 场景：开发新功能
+ * 编排：[检查上下文] → add_feature → estimate
+ */
+export declare function startFeature(args: any): Promise<{
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError?: undefined;
+} | {
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError: boolean;
+}>;

package/build/tools/start_feature.js

@@ -0,0 +1,122 @@
+/**
+ * start_feature 智能编排工具
+ *
+ * 场景：开发新功能
+ * 编排：[检查上下文] → add_feature → estimate
+ */
+const PROMPT_TEMPLATE = `# 🚀 新功能开发编排指南
+
+## 🎯 目标
+
+开发新功能：**{feature_name}**
+
+**功能描述**: {description}
+
+---
+
+## 📋 步骤 0: 项目上下文（自动处理）
+
+**操作**:
+1. 检查 \`{docs_dir}/project-context.md\` 是否存在
+2. **如果不存在**：
+   - 调用 \`init_project_context\` 工具
+   - 参数: \`{ "docs_dir": "{docs_dir}" }\`
+   - 等待生成完成
+3. **读取** \`{docs_dir}/project-context.md\` 内容
+4. 提取关键信息：技术栈、架构模式、编码规范
+5. 后续所有步骤都要参考此上下文
+
+---
+
+## 🚀 步骤 1: 生成功能规格
+
+**调用工具**: \`add_feature\`
+
+**参数**:
+\`\`\`json
+{
+  "feature_name": "{feature_name}",
+  "description": "{description}",
+  "docs_dir": "{docs_dir}"
+}
+\`\`\`
+
+**预期输出**:
+- \`{docs_dir}/specs/{feature_name}/requirements.md\` - 需求文档
+- \`{docs_dir}/specs/{feature_name}/design.md\` - 设计文档
+- \`{docs_dir}/specs/{feature_name}/tasks.md\` - 任务清单
+
+**注意**: 生成文档时要参考项目上下文中的技术栈和架构模式
+
+---
+
+## 📊 步骤 2: 工作量估算
+
+**调用工具**: \`estimate\`
+
+**参数**:
+\`\`\`json
+{
+  "task_description": "实现 {feature_name} 功能：{description}",
+  "code_context": "参考生成的 tasks.md 中的任务列表"
+}
+\`\`\`
+
+**预期输出**:
+- 故事点估算
+- 时间估算（乐观/正常/悲观）
+- 复杂度分析
+- 风险识别
+
+---
+
+## ✅ 完成检查
+
+- [ ] 项目上下文已读取/生成
+- [ ] requirements.md 已生成
+- [ ] design.md 已生成
+- [ ] tasks.md 已生成
+- [ ] 工作量估算已完成
+
+---
+
+## 📝 输出汇总
+
+完成后，向用户汇总：
+
+1. **功能规格文档位置**: \`{docs_dir}/specs/{feature_name}/\`
+2. **预估工作量**: X 故事点 / X-X 天
+3. **主要风险**: [列出识别的风险]
+4. **下一步**: 按 tasks.md 开始开发
+
+---
+
+*编排工具: MCP Probe Kit - start_feature*
+`;
+export async function startFeature(args) {
+    try {
+        const featureName = args?.feature_name;
+        const description = args?.description;
+        if (!featureName) {
+            throw new Error("缺少必填参数: feature_name（功能名称）");
+        }
+        if (!description) {
+            throw new Error("缺少必填参数: description（功能描述）");
+        }
+        const docsDir = args?.docs_dir || "docs";
+        const guide = PROMPT_TEMPLATE
+            .replace(/{feature_name}/g, featureName)
+            .replace(/{description}/g, description)
+            .replace(/{docs_dir}/g, docsDir);
+        return {
+            content: [{ type: "text", text: guide }],
+        };
+    }
+    catch (error) {
+        const errorMsg = error instanceof Error ? error.message : String(error);
+        return {
+            content: [{ type: "text", text: `❌ 编排执行失败: ${errorMsg}` }],
+            isError: true,
+        };
+    }
+}

package/build/tools/start_onboard.d.ts

@@ -0,0 +1,19 @@
+/**
+ * start_onboard 智能编排工具
+ *
+ * 场景：快速上手项目
+ * 编排：analyze_project → init_project_context
+ */
+export declare function startOnboard(args: any): Promise<{
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError?: undefined;
+} | {
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError: boolean;
+}>;

package/build/tools/start_onboard.js

@@ -0,0 +1,146 @@
+/**
+ * start_onboard 智能编排工具
+ *
+ * 场景：快速上手项目
+ * 编排：analyze_project → init_project_context
+ */
+const PROMPT_TEMPLATE = `# 📚 快速上手编排指南
+
+## 🎯 目标
+
+快速了解并上手当前项目
+
+---
+
+## 🔍 步骤 1: 项目分析
+
+**调用工具**: \`analyze_project\`
+
+**参数**:
+\`\`\`json
+{
+  "project_path": "{project_path}",
+  "max_depth": 5,
+  "include_content": true
+}
+\`\`\`
+
+**分析内容**:
+- 项目结构
+- 技术栈识别
+- 入口文件
+- 核心模块
+- 依赖关系
+
+**产出**: 项目分析报告
+
+---
+
+## 📝 步骤 2: 生成项目上下文
+
+**调用工具**: \`init_project_context\`
+
+**参数**:
+\`\`\`json
+{
+  "docs_dir": "{docs_dir}"
+}
+\`\`\`
+
+**生成内容**:
+- 技术栈文档
+- 架构说明
+- 编码规范
+- 开发指南
+
+**产出**: \`{docs_dir}/project-context.md\`
+
+---
+
+## ✅ 完成检查
+
+- [ ] 项目结构已分析
+- [ ] 技术栈已识别
+- [ ] 项目上下文已生成
+- [ ] 文档已保存
+
+---
+
+## 📊 输出汇总
+
+完成后，向用户提供：
+
+### 1. 项目概览
+
+| 项目 | 内容 |
+|------|------|
+| 项目名称 | [名称] |
+| 项目类型 | [前端/后端/全栈/库] |
+| 主要语言 | [语言] |
+| 框架 | [框架] |
+
+### 2. 技术栈
+
+| 类别 | 技术 |
+|------|------|
+| 语言 | [语言列表] |
+| 框架 | [框架列表] |
+| 构建工具 | [工具列表] |
+| 测试框架 | [框架列表] |
+
+### 3. 项目结构
+
+\`\`\`
+[目录树]
+\`\`\`
+
+### 4. 核心文件
+
+| 文件 | 用途 |
+|------|------|
+| [文件1] | [用途] |
+| [文件2] | [用途] |
+
+### 5. 快速开始
+
+\`\`\`bash
+# 安装依赖
+[安装命令]
+
+# 启动开发
+[启动命令]
+
+# 运行测试
+[测试命令]
+\`\`\`
+
+### 6. 下一步建议
+
+1. 阅读 \`{docs_dir}/project-context.md\` 了解详细信息
+2. 查看 README.md 了解项目背景
+3. 运行项目熟悉功能
+4. 阅读核心模块代码
+
+---
+
+*编排工具: MCP Probe Kit - start_onboard*
+`;
+export async function startOnboard(args) {
+    try {
+        const projectPath = args?.project_path || ".";
+        const docsDir = args?.docs_dir || "docs";
+        const guide = PROMPT_TEMPLATE
+            .replace(/{project_path}/g, projectPath)
+            .replace(/{docs_dir}/g, docsDir);
+        return {
+            content: [{ type: "text", text: guide }],
+        };
+    }
+    catch (error) {
+        const errorMsg = error instanceof Error ? error.message : String(error);
+        return {
+            content: [{ type: "text", text: `❌ 编排执行失败: ${errorMsg}` }],
+            isError: true,
+        };
+    }
+}

package/build/tools/start_refactor.d.ts

@@ -0,0 +1,19 @@
+/**
+ * start_refactor 智能编排工具
+ *
+ * 场景：代码重构
+ * 编排：[检查上下文] → code_review → refactor → gentest
+ */
+export declare function startRefactor(args: any): Promise<{
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError?: undefined;
+} | {
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError: boolean;
+}>;

package/build/tools/start_refactor.js

@@ -0,0 +1,175 @@
+/**
+ * start_refactor 智能编排工具
+ *
+ * 场景：代码重构
+ * 编排：[检查上下文] → code_review → refactor → gentest
+ */
+const PROMPT_TEMPLATE = `# ♻️ 代码重构编排指南
+
+## 🎯 目标
+
+重构以下代码：
+
+\`\`\`
+{code}
+\`\`\`
+
+**重构目标**: {goal}
+
+---
+
+## 📋 步骤 0: 项目上下文（自动处理）
+
+**操作**:
+1. 检查 \`docs/project-context.md\` 是否存在
+2. **如果不存在**：
+   - 调用 \`init_project_context\` 工具
+   - 等待生成完成
+3. **读取** \`docs/project-context.md\` 内容
+4. 了解项目的架构模式、编码规范
+5. 重构要符合项目规范
+
+---
+
+## 🔍 步骤 1: 代码审查（发现问题）
+
+**调用工具**: \`code_review\`
+
+**参数**:
+\`\`\`json
+{
+  "code": "[待重构代码]",
+  "focus": "quality"
+}
+\`\`\`
+
+**目的**:
+- 识别代码坏味道
+- 发现可改进点
+- 评估当前代码质量
+
+**产出**: 问题清单
+
+---
+
+## ♻️ 步骤 2: 生成重构方案
+
+**调用工具**: \`refactor\`
+
+**参数**:
+\`\`\`json
+{
+  "code": "[待重构代码]",
+  "goal": "{goal}"
+}
+\`\`\`
+
+**重构方向**:
+- improve_readability: 提高可读性
+- reduce_complexity: 降低复杂度
+- extract_function: 提取函数
+- remove_duplication: 消除重复
+- improve_naming: 改进命名
+
+**产出**: 重构后的代码 + 重构说明
+
+---
+
+## 🧪 步骤 3: 生成保护测试
+
+**调用工具**: \`gentest\`
+
+**参数**:
+\`\`\`json
+{
+  "code": "[重构后的代码]",
+  "framework": "[根据项目上下文选择]"
+}
+\`\`\`
+
+**目的**:
+- 确保重构不改变行为
+- 为重构后的代码提供测试保护
+- 覆盖主要功能和边界情况
+
+**产出**: 测试代码
+
+---
+
+## ✅ 完成检查
+
+- [ ] 项目上下文已读取
+- [ ] 代码问题已识别
+- [ ] 重构方案已生成
+- [ ] 代码已重构
+- [ ] 测试已添加
+- [ ] 测试已通过
+
+---
+
+## 📝 输出汇总
+
+完成后，向用户提供：
+
+### 1. 重构前后对比
+
+**重构前**:
+\`\`\`
+[原代码]
+\`\`\`
+
+**重构后**:
+\`\`\`
+[新代码]
+\`\`\`
+
+### 2. 改进说明
+
+| 改进项 | 说明 |
+|--------|------|
+| [改进1] | [说明] |
+| [改进2] | [说明] |
+
+### 3. 测试覆盖
+
+- 测试用例数: X
+- 覆盖场景: [列出]
+
+### 4. 注意事项
+
+- [重构可能影响的地方]
+- [需要同步修改的地方]
+
+---
+
+*编排工具: MCP Probe Kit - start_refactor*
+`;
+export async function startRefactor(args) {
+    try {
+        const code = args?.code;
+        if (!code) {
+            throw new Error("缺少必填参数: code（需要重构的代码）");
+        }
+        const goal = args?.goal || "improve_readability";
+        const goalDesc = {
+            improve_readability: "提高可读性",
+            reduce_complexity: "降低复杂度",
+            extract_function: "提取函数",
+            remove_duplication: "消除重复",
+            improve_naming: "改进命名",
+        };
+        const guide = PROMPT_TEMPLATE
+            .replace(/{code}/g, code)
+            .replace(/{goal}/g, goalDesc[goal] || goal);
+        return {
+            content: [{ type: "text", text: guide }],
+        };
+    }
+    catch (error) {
+        const errorMsg = error instanceof Error ? error.message : String(error);
+        return {
+            content: [{ type: "text", text: `❌ 编排执行失败: ${errorMsg}` }],
+            isError: true,
+        };
+    }
+}

package/build/tools/start_release.d.ts

@@ -0,0 +1,19 @@
+/**
+ * start_release 智能编排工具
+ *
+ * 场景：发布准备
+ * 编排：[检查上下文] → genchangelog → genpr
+ */
+export declare function startRelease(args: any): Promise<{
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError?: undefined;
+} | {
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError: boolean;
+}>;