mcp-probe-kit 3.0.23 → 3.1.0

package/build/tools/gendoc.js

@@ -0,0 +1,232 @@
+import { parseArgs, getString } from "../utils/parseArgs.js";
+// gendoc 工具实现
+export async function gendoc(args) {
+    try {
+        // 智能参数解析，支持自然语言输入
+        const parsedArgs = parseArgs(args, {
+            defaultValues: {
+                code: "",
+                style: "jsdoc",
+                lang: "zh",
+            },
+            primaryField: "code", // 纯文本输入默认映射到 code 字段
+            fieldAliases: {
+                code: ["source", "src", "代码", "function"],
+                style: ["format", "type", "风格", "注释风格"],
+                lang: ["language", "语言"],
+            },
+        });
+        const code = getString(parsedArgs.code);
+        const style = getString(parsedArgs.style) || "jsdoc"; // jsdoc, tsdoc, javadoc
+        const lang = getString(parsedArgs.lang) || "zh"; // zh, en
+        const message = `请为以下代码生成详细的注释文档：
+
+📝 **代码内容**：
+${code || "请提供需要生成注释的代码"}
+
+📖 **注释风格**：${style}
+🌐 **语言**：${lang === "zh" ? "中文" : "English"}
+
+---
+
+## 注释生成指南
+
+### JSDoc/TSDoc 格式
+
+**函数注释模板**：
+\`\`\`typescript
+/**
+ * 函数简短描述（一句话）
+ * 
+ * 详细描述功能、用途、使用场景（可选，多行）
+ * 
+ * @param {类型} 参数名 - 参数描述
+ * @param {类型} 参数名 - 参数描述
+ * @returns {类型} 返回值描述
+ * @throws {ErrorType} 抛出异常的情况
+ * 
+ * @example
+ * // 使用示例
+ * const result = functionName(arg1, arg2);
+ * console.log(result); // 输出: ...
+ * 
+ * @see 相关函数或文档链接
+ * @since 1.0.0
+ * @deprecated 使用 newFunction 替代（如果已废弃）
+ */
+function functionName(param1, param2) {
+  // ...
+}
+\`\`\`
+
+**类注释模板**：
+\`\`\`typescript
+/**
+ * 类简短描述
+ * 
+ * 详细描述类的职责、使用场景
+ * 
+ * @class
+ * @example
+ * const instance = new ClassName(param);
+ * instance.method();
+ */
+class ClassName {
+  /**
+   * 构造函数描述
+   * @param {类型} param - 参数描述
+   */
+  constructor(param) {}
+  
+  /**
+   * 方法描述
+   * @returns {类型} 返回值描述
+   */
+  method() {}
+}
+\`\`\`
+
+**接口注释模板**：
+\`\`\`typescript
+/**
+ * 接口描述
+ * 
+ * @interface
+ */
+interface InterfaceName {
+  /** 属性描述 */
+  property: string;
+  
+  /**
+   * 方法描述
+   * @param {类型} param - 参数描述
+   * @returns {类型} 返回值描述
+   */
+  method(param: string): void;
+}
+\`\`\`
+
+**类型注释模板**：
+\`\`\`typescript
+/**
+ * 类型描述
+ * 
+ * @typedef {Object} TypeName
+ * @property {string} prop1 - 属性 1 描述
+ * @property {number} prop2 - 属性 2 描述
+ */
+type TypeName = {
+  prop1: string;
+  prop2: number;
+};
+\`\`\`
+
+---
+
+## 注释内容要求
+
+### 必须包含
+
+1. **功能描述**
+   - 简短说明（一句话）
+   - 详细说明（用途、场景、原理）
+
+2. **参数说明**
+   - 参数类型
+   - 参数含义
+   - 是否可选
+   - 默认值（如有）
+   - 取值范围/约束（如有）
+
+3. **返回值**
+   - 返回类型
+   - 返回值含义
+   - 可能的返回值
+
+4. **异常情况**
+   - 可能抛出的异常
+   - 抛出条件
+
+5. **使用示例**
+   - 基本用法
+   - 典型场景
+   - 边界情况
+
+### 可选包含
+
+1. **复杂度**：\`@complexity O(n)\`
+2. **版本信息**：\`@since 1.0.0\`
+3. **作者**：\`@author Kyle\`
+4. **废弃信息**：\`@deprecated\`
+5. **相关链接**：\`@see\`
+6. **待办事项**：\`@todo\`
+
+---
+
+## 注释质量标准
+
+**好的注释**：
+- ✅ 说明"为什么"，而不只是"做什么"
+- ✅ 描述边界条件和特殊情况
+- ✅ 提供有意义的示例
+- ✅ 保持与代码同步
+- ✅ 使用清晰简洁的语言
+
+**避免的注释**：
+- ❌ 重复代码内容的注释
+- ❌ 过时的注释
+- ❌ 误导性的注释
+- ❌ 废话注释（如：\`// 定义变量 x\`）
+
+---
+
+## 特殊注释标记
+
+**标记类型**：
+\`\`\`typescript
+// TODO: 待实现的功能
+// FIXME: 需要修复的问题
+// HACK: 临时解决方案
+// NOTE: 重要说明
+// WARNING: 警告信息
+// OPTIMIZE: 可优化的地方
+\`\`\`
+
+---
+
+---
+
+## ⚠️ 边界约束
+
+- ❌ 仅输出注释，不改变代码逻辑
+- ❌ 不执行代码或命令
+- ✅ 补全参数/返回值/异常/示例说明
+- ✅ 输出带完整注释的代码
+
+现在请为代码生成${lang === "zh" ? "中文" : "英文"}的${style}风格注释文档，包括：
+1. 完整的函数/类/接口注释
+2. 复杂逻辑的行内注释
+3. 使用示例
+4. 特殊情况说明`;
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: message,
+                },
+            ],
+        };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `❌ 生成注释失败: ${errorMessage}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}

package/build/tools/genpr.d.ts

@@ -0,0 +1,13 @@
+export declare function genpr(args: any): Promise<{
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError?: undefined;
+} | {
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError: boolean;
+}>;

package/build/tools/genpr.js

@@ -0,0 +1,194 @@
+import { parseArgs, getString } from "../utils/parseArgs.js";
+// genpr 工具实现
+export async function genpr(args) {
+    try {
+        // 智能参数解析，支持自然语言输入
+        const parsedArgs = parseArgs(args, {
+            defaultValues: {
+                branch: "",
+                commits: "",
+            },
+            primaryField: "commits", // 纯文本输入默认映射到 commits 字段
+            fieldAliases: {
+                branch: ["分支", "branch_name"],
+                commits: ["commit_history", "log", "提交", "提交历史"],
+            },
+        });
+        const branch = getString(parsedArgs.branch);
+        const commits = getString(parsedArgs.commits);
+        const message = `请生成规范的 Pull Request 描述：
+
+📝 **分支信息**：
+${branch || "请提供分支名称"}
+
+📋 **Commit 历史**：
+${commits || "请先执行 git log 查看 commit 历史"}
+
+---
+
+## PR 描述生成指南
+
+### 第一步：分析变更内容
+
+执行以下命令获取详细信息：
+\`\`\`bash
+# 查看 commit 历史
+git log origin/main..HEAD --oneline
+
+# 查看具体变更
+git diff origin/main..HEAD --stat
+
+# 查看修改的文件
+git diff origin/main..HEAD --name-only
+\`\`\`
+
+### 第二步：生成 PR 描述
+
+**标准 PR 模板**：
+
+\`\`\`markdown
+## 📝 变更说明
+
+### 概述
+简要说明这个 PR 的目的和背景（2-3 句话）
+
+### 变更内容
+- 🎨 UI/UX 改进：...
+- ✨ 新功能：...
+- 🐛 Bug 修复：...
+- ♻️ 重构：...
+- 📝 文档更新：...
+- 🚀 性能优化：...
+
+## 🎯 解决的问题
+
+Closes #123
+Fixes #456
+Relates to #789
+
+## 🔧 技术细节
+
+### 主要修改
+1. **模块 A**：修改内容和原因
+2. **模块 B**：修改内容和原因
+
+### 架构变更（如有）
+- 数据库 Schema 变更
+- API 接口变更
+- 配置文件变更
+
+### 依赖变更（如有）
+- 新增依赖：\`package-name@version\`
+- 移除依赖：\`old-package\`
+- 升级依赖：\`package@old → package@new\`
+
+## ✅ 测试计划
+
+### 单元测试
+- [x] 新增测试用例覆盖新功能
+- [x] 所有测试通过
+- [x] 测试覆盖率 > 80%
+
+### 集成测试
+- [x] API 接口测试通过
+- [x] 端到端测试通过
+
+### 手动测试
+- [x] 功能 A 正常工作
+- [x] 功能 B 正常工作
+- [x] 边界情况验证
+
+## 📸 截图/录屏（UI 变更时）
+
+### Before
+![Before Screenshot](url)
+
+### After
+![After Screenshot](url)
+
+## ⚠️ 注意事项
+
+### Breaking Changes（破坏性变更）
+- ⚠️ API 路径从 \`/old\` 改为 \`/new\`
+- ⚠️ 配置文件格式变更
+
+### 部署注意
+- 需要执行数据库迁移：\`npm run migrate\`
+- 需要更新环境变量：\`NEW_VAR=value\`
+- 需要重启服务
+
+### 向后兼容性
+- ✅ 完全兼容
+- ⚠️ 部分兼容（说明不兼容的部分）
+- ❌ 不兼容（需要特殊处理）
+
+## 📋 Checklist
+
+- [ ] 代码通过 lint 检查
+- [ ] 所有测试通过
+- [ ] 文档已更新
+- [ ] Changelog 已更新
+- [ ] 性能影响已评估
+- [ ] 安全影响已评估
+- [ ] 代码已自我审查
+- [ ] 已添加必要的注释
+
+## 🔗 相关链接
+
+- 设计文档：[链接]
+- 技术方案：[链接]
+- 相关 PR：#xxx
+
+## 👥 审查者
+
+@reviewer1 @reviewer2
+
+## 🙏 致谢
+
+感谢 @contributor1 的建议
+\`\`\`
+
+---
+
+## PR 标题规范
+
+格式：\`<type>(<scope>): <subject>\`
+
+**示例**：
+- \`feat(auth): 添加 OAuth2 登录支持\`
+- \`fix(api): 修复用户查询接口分页错误\`
+- \`refactor(ui): 重构组件层级结构\`
+
+---
+
+---
+
+## ⚠️ 边界约束
+
+- ❌ 仅输出 PR 描述文本，不自动创建 PR
+- ❌ 不执行 git 命令
+- ✅ 输出完整的 PR 描述 Markdown
+
+现在请根据变更内容生成完整的 PR 描述，并建议合适的审查者。`;
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: message,
+                },
+            ],
+        };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `❌ 生成 PR 描述失败: ${errorMessage}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}

package/build/tools/genreadme.d.ts

@@ -0,0 +1,13 @@
+export declare function genreadme(args: any): Promise<{
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError?: undefined;
+} | {
+    content: {
+        type: string;
+        text: string;
+    }[];
+    isError: boolean;
+}>;