mcp-probe-kit 3.6.10 → 3.6.11

package/build/tools/refactor.js

@@ -1,383 +1,155 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
-import { okText } from "../lib/response.js";
+import { okStructured } from "../lib/response.js";
 import { renderGuidanceHeader } from "../lib/guidance.js";
 import { handleToolError } from "../utils/error-handler.js";
-// refactor 工具实现
+import { resolveGuidanceCode, trimCodeForPrompt } from "../lib/code-review-input.js";
+import { resolveWorkspaceRoot } from "../lib/workspace-root.js";
 export async function refactor(args) {
     try {
-        // 智能参数解析，支持自然语言输入
         const parsedArgs = parseArgs(args, {
             defaultValues: {
                 code: "",
                 goal: "",
+                file_path: "",
+                project_root: "",
             },
-            primaryField: "code", // 纯文本输入默认映射到 code 字段
+            primaryField: "code",
             fieldAliases: {
                 code: ["source", "src", "代码", "content"],
                 goal: ["target", "objective", "目标", "重构目标"],
+                file_path: ["filePath", "filepath", "path", "文件路径"],
+                project_root: ["projectRoot", "project_path", "dir", "directory", "项目路径"],
             },
         });
-        const code = getString(parsedArgs.code);
-        const goal = getString(parsedArgs.goal); // improve_readability, reduce_complexity, extract_function, etc.
+        const goal = getString(parsedArgs.goal) || "全面优化";
+        const inlineCode = getString(parsedArgs.code) || getString(parsedArgs.input);
+        const filePath = getString(parsedArgs.file_path);
+        const projectRoot = getString(parsedArgs.project_root);
+        const resolved = resolveGuidanceCode({
+            code: inlineCode,
+            filePath: filePath || undefined,
+            projectRoot: projectRoot ? resolveWorkspaceRoot(projectRoot) : undefined,
+        });
+        if (resolved.error) {
+            return okStructured(`❌ refactor 无法读取输入: ${resolved.error}`, {
+                mode: "guidance",
+                refactorInput: {
+                    received: false,
+                    error: resolved.error,
+                    file: filePath || null,
+                    goal,
+                },
+            }, {
+                note: "指南型工具：请修正 file_path / project_root 或传入 code 后，由 Agent 输出重构计划",
+            });
+        }
+        const hasCode = Boolean(resolved.code.trim());
+        const promptCode = hasCode ? trimCodeForPrompt(resolved.code, 24000, "refactorInput") : "";
         const header = renderGuidanceHeader({
             tool: "refactor",
-            goal: "分析代码并提供详细的重构建议和实施计划。",
-            tasks: ["识别代码坏味道", "提供重构步骤", "评估风险和收益"],
-            outputs: ["重构计划（包含步骤、风险评估、预期收益）"],
+            goal: "由 Agent 根据下方代码与重构清单分析坏味道，并输出重构计划与示例代码。",
+            tasks: [
+                "先阅读本次注入的 refactorInput.code（或 file_path 对应文件）",
+                "识别代码坏味道并给出优先级",
+                "在回复中输出结构化重构计划 JSON",
+            ],
+            outputs: ["重构计划（步骤、风险评估、预期收益）— 由 Agent 生成，非 MCP 自动分析"],
+            notes: [
+                "本工具为指南型（guidance-only），不在服务端自动修改源文件",
+                hasCode ? `已注入待重构代码（${resolved.code.split("\n").length} 行）` : "未收到 code/file_path，请先提供待重构内容",
+            ],
         });
-        const message = `${header}请为以下代码提供重构建议：
-
-📝 **代码内容**：
-${code || "请提供需要重构的代码"}
-
-🎯 **重构目标**：${goal || "全面优化"}
-
----
-
-## 重构分析流程
-
-### 第一步：识别代码坏味道
-
-**常见问题**：
-1. **重复代码（Duplicated Code）**
-   - 相同或相似的代码出现多次
-   - 建议：提取公共函数/方法
-
-2. **过长函数（Long Function）**
-   - 函数超过 30 行
-   - 建议：拆分为多个小函数
-
-3. **过大类（Large Class）**
-   - 类职责过多
-   - 建议：按职责拆分类
-
-4. **过长参数列表（Long Parameter List）**
-   - 参数超过 3-4 个
-   - 建议：使用对象封装参数
-
-5. **复杂条件判断（Complex Conditional）**
-   - 嵌套超过 3 层
-   - 建议：提前返回、使用策略模式
-
-6. **魔法数字（Magic Numbers）**
-   - 硬编码的数字
-   - 建议：使用常量
-
-7. **紧耦合（Tight Coupling）**
-   - 模块间依赖过强
-   - 建议：依赖注入、接口抽象
-
-### 第二步：重构建议
-
-**优先级分类**：
-- 🔴 **Critical**：严重影响可维护性
-- 🟡 **Important**：建议尽快处理
-- 🟢 **Nice-to-have**：可选优化
-
----
-
-## 重构技术清单
-
-### 1️⃣ 提取函数（Extract Function）
-
-**场景**：一段代码可以被独立理解
-
-**示例**：
-\`\`\`typescript
-// Before
-function processOrder(order) {
-  // 验证订单
-  if (!order.id || !order.items || order.items.length === 0) {
-    throw new Error('Invalid order');
-  }
-  
-  // 计算总价
-  let total = 0;
-  for (const item of order.items) {
-    total += item.price * item.quantity;
-  }
-  
-  // 应用折扣
-  if (order.coupon) {
-    total = total * (1 - order.coupon.discount);
-  }
-  
-  return total;
-}
-
-// After
-function processOrder(order) {
-  validateOrder(order);
-  const subtotal = calculateSubtotal(order.items);
-  const total = applyDiscount(subtotal, order.coupon);
-  return total;
-}
-
-function validateOrder(order) {
-  if (!order.id || !order.items || order.items.length === 0) {
-    throw new Error('Invalid order');
-  }
-}
-
-function calculateSubtotal(items) {
-  return items.reduce((sum, item) => sum + item.price * item.quantity, 0);
-}
-
-function applyDiscount(amount, coupon) {
-  return coupon ? amount * (1 - coupon.discount) : amount;
-}
-\`\`\`
-
-### 2️⃣ 简化条件表达式
-
-**技巧**：
-- 使用提前返回（Early Return）
-- 合并条件
-- 使用三元运算符
-- 策略模式替代 switch
-
-**示例**：
-\`\`\`typescript
-// Before
-function getDiscount(user) {
-  if (user) {
-    if (user.isPremium) {
-      if (user.orderCount > 10) {
-        return 0.3;
-      } else {
-        return 0.2;
-      }
-    } else {
-      return 0.1;
-    }
-  } else {
-    return 0;
-  }
-}
-
-// After
-function getDiscount(user) {
-  if (!user) return 0;
-  if (!user.isPremium) return 0.1;
-  return user.orderCount > 10 ? 0.3 : 0.2;
-}
-\`\`\`
-
-### 3️⃣ 引入参数对象
-
-**场景**：参数过多
-
-**示例**：
-\`\`\`typescript
-// Before
-function createUser(name, email, age, address, phone, country) {
-  // ...
-}
-
-// After
-interface UserData {
-  name: string;
-  email: string;
-  age: number;
-  address: string;
-  phone: string;
-  country: string;
-}
-
-function createUser(userData: UserData) {
-  // ...
-}
-\`\`\`
-
-### 4️⃣ 替换魔法数字
-
-**示例**：
-\`\`\`typescript
-// Before
-if (status === 1) {
-  // ...
-} else if (status === 2) {
-  // ...
-}
-
-// After
-enum OrderStatus {
-  PENDING = 1,
-  PROCESSING = 2,
-  COMPLETED = 3
-}
-
-if (status === OrderStatus.PENDING) {
-  // ...
-} else if (status === OrderStatus.PROCESSING) {
-  // ...
-}
-\`\`\`
-
-### 5️⃣ 组合函数调用
-
-**示例**：
-\`\`\`typescript
-// Before
-const data = getData();
-const filtered = filterData(data);
-const sorted = sortData(filtered);
-const formatted = formatData(sorted);
-
-// After
-const result = getData()
-  .then(filterData)
-  .then(sortData)
-  .then(formatData);
-
-// Or using pipe
-const result = pipe(
-  getData,
-  filterData,
-  sortData,
-  formatData
-)();
-\`\`\`
-
----
-
-## 重构计划模板
-
-### 🎯 重构目标
-简要说明重构的目的和预期效果
-
-### 📋 问题清单
-1. **问题 1**：重复代码
-   - 位置：第 10-20 行、第 50-60 行
-   - 影响：可维护性差
-   - 优先级：🔴 Critical
-
-2. **问题 2**：函数过长
-   - 位置：processData() 函数
-   - 影响：难以理解和测试
-   - 优先级：🟡 Important
-
-### 🔧 重构步骤
-
-**步骤 1：准备**
-- [x] 确保测试覆盖率 > 80%
-- [x] 备份当前代码
-- [x] 创建重构分支
-
-**步骤 2：小步重构**
-1. 提取 calculateTotal 函数
-   - 风险：低
-   - 预计时间：10 分钟
-   - 测试：运行单元测试
-
-2. 简化条件判断
-   - 风险：低
-   - 预计时间：15 分钟
-   - 测试：运行集成测试
-
-3. 引入参数对象
-   - 风险：中
-   - 预计时间：30 分钟
-   - 测试：全量测试
-
-**步骤 3：验证**
-- [ ] 所有测试通过
-- [ ] 代码审查
-- [ ] 性能对比
-- [ ] 部署到测试环境
-
-### ⚠️ 风险评估
-
-**高风险操作**：
-- 修改公共 API
-- 改变数据结构
-- 调整核心算法
-
-**降低风险的措施**：
-- 渐进式重构（小步快跑）
-- 每步都运行测试
-- 保持功能不变
-- Code Review
-
-### 📊 预期收益
-
-**可维护性**：⬆️ 30%
-- 代码行数减少 20%
-- 圈复杂度降低 40%
-
-**可测试性**：⬆️ 50%
-- 函数职责单一
-- 依赖可注入
-
-**性能**：⬆️ 10%
-- 减少重复计算
-- 优化算法复杂度
-
----
-
----
-
-## ⚠️ 边界约束
-
-- ❌ 仅输出重构建议和代码，不自动修改源文件
-- ❌ 不执行代码或命令
-- ✅ 保持功能不变，仅改善代码结构
-- ✅ 输出结构化重构方案和示例代码
-
----
-
-## 📤 输出格式要求
-
-请严格按以下 JSON 格式输出重构计划：
-
-\`\`\`json
-{
-  "summary": "重构摘要",
-  "goal": "improve_readability|reduce_complexity|improve_performance|improve_maintainability|modernize",
-  "currentIssues": ["问题1", "问题2"],
-  "refactoringSteps": [
-    {
-      "step": 1,
-      "title": "步骤标题",
-      "description": "步骤描述",
-      "before": "重构前代码",
-      "after": "重构后代码",
-      "rationale": "重构理由"
-    }
-  ],
-  "riskAssessment": {
-    "level": "low|medium|high",
-    "risks": ["风险1", "风险2"],
-    "mitigations": ["缓解措施1", "缓解措施2"]
-  },
-  "expectedBenefits": ["收益1", "收益2"]
-}
-\`\`\`
-
-现在请分析代码，提供详细的重构建议和实施计划。
-
----
-
-## 📤 输出格式要求
-
-请输出完整的重构报告，包含：
-
-1. **重构概述**：简要说明重构目标和主要问题
-2. **重构步骤**：详细的步骤列表（每步包含：描述、原因、示例代码）
-3. **风险评估**：风险级别和具体风险点
-4. **预期收益**：重构后的改进点
-5. **实施建议**：优先级和注意事项
-
-💡 **提示**：
-- 提供具体的代码示例（重构前 vs 重构后）
-- 说明每个步骤的必要性和影响
-- 评估风险并提供缓解措施`;
-        return okText(message, {
-            schema: (await import('../schemas/output/core-tools.js')).RefactorPlanSchema,
-            note: "本工具返回重构指南，AI 应根据指南分析代码并输出重构计划"
+        const message = `${header}请为以下代码提供重构建议：
+
+📝 **待重构代码**${resolved.file ? `（来源: ${resolved.file}）` : ""}：
+${hasCode ? `\`\`\`\n${promptCode}\n\`\`\`` : "_未提供 code / file_path，请 Agent 先读取目标文件或让用户补充后再分析_"}
+
+🎯 **重构目标**：${goal}
+
+---
+
+## 重构分析流程
+
+### 第一步：识别代码坏味道
+
+**常见问题**：
+1. **重复代码（Duplicated Code）** — 建议提取公共函数
+2. **过长函数（Long Function）** — 建议拆分
+3. **过大类（Large Class）** — 建议按职责拆分
+4. **过长参数列表** — 建议对象封装
+5. **复杂条件判断** — 提前返回、策略模式
+6. **魔法数字** — 使用常量
+7. **紧耦合** — 依赖注入、接口抽象
+
+### 第二步：重构建议优先级
+
+- 🔴 **Critical**：严重影响可维护性
+- 🟡 **Important**：建议尽快处理
+- 🟢 **Nice-to-have**：可选优化
+
+---
+
+## 重构技术参考
+
+- 提取函数（Extract Function）
+- 简化条件表达式（Early Return）
+- 引入参数对象
+- 替换魔法数字
+- 组合函数调用 / pipe
+
+---
+
+## ⚠️ 边界约束
+
+- MCP 仅返回指南 + 注入的代码，**重构计划由 Agent 分析后生成**
+- ❌ 不自动修改源文件，不执行命令
+- ✅ 保持功能不变，仅改善代码结构
+
+---
+
+## 📤 Agent 必须输出的 JSON 格式
+
+\`\`\`json
+{
+  "summary": "重构摘要",
+  "goal": "improve_readability|reduce_complexity|improve_performance|improve_maintainability|modernize",
+  "currentIssues": ["问题1", "问题2"],
+  "refactoringSteps": [
+    {
+      "step": 1,
+      "title": "步骤标题",
+      "description": "步骤描述",
+      "before": "重构前代码",
+      "after": "重构后代码",
+      "rationale": "重构理由"
+    }
+  ],
+  "riskAssessment": {
+    "level": "low|medium|high",
+    "risks": ["风险1"],
+    "mitigations": ["缓解措施1"]
+  },
+  "expectedBenefits": ["收益1"]
+}
+\`\`\`
+
+现在请分析代码，提供详细的重构建议和实施计划。`;
+        return okStructured(message, {
+            mode: "guidance",
+            refactorInput: {
+                received: hasCode,
+                goal,
+                file: resolved.file ?? null,
+                lineCount: hasCode ? resolved.code.split("\n").length : 0,
+                code: hasCode ? resolved.code : null,
+                truncatedInPrompt: hasCode && resolved.code.length !== promptCode.length,
+            },
+        }, {
+            schema: (await import("../schemas/output/core-tools.js")).RefactorPlanSchema,
+            note: "指南型工具：重构计划须由 Agent 分析后生成；MCP 不返回自动分析结果",
         });
     }
     catch (error) {
-        return handleToolError(error, 'refactor');
+        return handleToolError(error, "refactor");
     }
 }