mcp-probe-kit 3.0.23 → 3.1.0

package/build/tools/genapi.js

@@ -0,0 +1,174 @@
+import { parseArgs, getString } from "../utils/parseArgs.js";
+// genapi 工具实现
+export async function genapi(args) {
+    try {
+        // 智能参数解析，支持自然语言输入
+        const parsedArgs = parseArgs(args, {
+            defaultValues: {
+                code: "",
+                format: "markdown",
+            },
+            primaryField: "code", // 纯文本输入默认映射到 code 字段
+            fieldAliases: {
+                code: ["source", "api", "代码", "endpoint"],
+                format: ["output_format", "type", "格式", "输出格式"],
+            },
+        });
+        const code = getString(parsedArgs.code);
+        const format = getString(parsedArgs.format) || "markdown"; // markdown, openapi, jsdoc
+        const message = `请为以下代码生成 API 文档：
+
+📝 **代码**：
+${code || "请提供需要生成文档的代码（函数、类、API 端点等）"}
+
+📖 **文档格式**：${format}
+
+---
+
+🎯 **API 文档生成指南**：
+
+**基础信息**：
+- API 名称和描述
+- 版本信息
+- 基础 URL
+
+**详细文档**（每个端点/函数）：
+
+1. **功能描述**
+   - 简短说明（一句话）
+   - 详细描述（用途、场景）
+
+2. **请求参数**
+   | 参数名 | 类型 | 必填 | 描述 | 示例 |
+   |--------|------|------|------|------|
+   | id | string | 是 | 用户 ID | "12345" |
+   | name | string | 否 | 用户名 | "张三" |
+
+3. **返回值**
+   - 成功响应（状态码、数据结构、示例）
+   - 错误响应（错误码、错误信息）
+
+4. **示例代码**
+   \`\`\`typescript
+   // 请求示例
+   const response = await fetch('/api/users/123');
+   const data = await response.json();
+   
+   // 响应示例
+   {
+     "code": 200,
+     "data": {
+       "id": "123",
+       "name": "张三"
+     }
+   }
+   \`\`\`
+
+5. **注意事项**
+   - 权限要求
+   - 速率限制
+   - 废弃信息
+   - 相关链接
+
+---
+
+**Markdown 格式模板**：
+\`\`\`markdown
+# API 文档
+
+## 用户管理
+
+### 获取用户信息
+
+**接口地址**：\`GET /api/users/:id\`
+
+**功能描述**：根据用户 ID 获取用户详细信息
+
+**请求参数**：
+| 参数 | 类型 | 必填 | 描述 |
+|------|------|------|------|
+| id | string | 是 | 用户 ID |
+
+**返回示例**：
+\`\`\`json
+{
+  "code": 200,
+  "data": {
+    "id": "123",
+    "name": "张三",
+    "email": "zhangsan@example.com"
+  }
+}
+\`\`\`
+
+**错误码**：
+- 404: 用户不存在
+- 403: 无权限访问
+\`\`\`
+
+---
+
+**OpenAPI 3.0 格式模板**：
+\`\`\`yaml
+openapi: 3.0.0
+info:
+  title: User API
+  version: 1.0.0
+paths:
+  /api/users/{id}:
+    get:
+      summary: 获取用户信息
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: integer
+                  data:
+                    type: object
+\`\`\`
+
+---
+
+---
+
+## ⚠️ 边界约束
+
+- ❌ 仅输出文档，不修改业务代码
+- ❌ 不执行代码或命令
+- ✅ 基于现有接口定义/路由/注释推断
+- ✅ 输出完整的 API 文档
+
+现在请根据上述代码生成完整的 API 文档。`;
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: message,
+                },
+            ],
+        };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `❌ 生成 API 文档失败: ${errorMessage}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}

package/build/tools/genchangelog.d.ts

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

package/build/tools/genchangelog.js

@@ -0,0 +1,250 @@
+import { parseArgs, getString } from "../utils/parseArgs.js";
+// genchangelog 工具实现
+export async function genchangelog(args) {
+    try {
+        // 智能参数解析，支持自然语言输入
+        const parsedArgs = parseArgs(args, {
+            defaultValues: {
+                version: "",
+                from: "",
+                to: "HEAD",
+            },
+            primaryField: "version", // 纯文本输入默认映射到 version 字段
+            fieldAliases: {
+                version: ["ver", "v", "版本", "版本号"],
+                from: ["from_tag", "start", "起始", "起始版本"],
+                to: ["to_tag", "end", "结束", "结束版本"],
+            },
+        });
+        const version = getString(parsedArgs.version);
+        const from = getString(parsedArgs.from);
+        const to = getString(parsedArgs.to) || "HEAD";
+        const message = `请生成项目的 CHANGELOG（变更日志）：
+
+📝 **版本信息**：
+${version || "请提供版本号（如：v1.2.0）"}
+
+📋 **Commit 范围**：
+从 ${from || "上一个 tag"} 到 ${to}
+
+---
+
+## Changelog 生成步骤
+
+### 第一步：获取 Commit 历史
+
+执行以下命令：
+\`\`\`bash
+# 查看 commit 历史
+git log ${from}..${to} --oneline --no-merges
+
+# 查看详细信息
+git log ${from}..${to} --pretty=format:"%h - %s (%an)" --no-merges
+
+# 查看所有 tags
+git tag -l
+
+# 查看贡献者
+git shortlog ${from}..${to} -sn
+\`\`\`
+
+### 第二步：分类 Commits
+
+按类型分组：
+- **✨ Features (feat)**：新功能
+- **🐛 Bug Fixes (fix)**：Bug 修复
+- **📝 Documentation (docs)**：文档变更
+- **💄 Styles (style)**：代码格式
+- **♻️ Refactoring (refactor)**：重构
+- **⚡ Performance (perf)**：性能优化
+- **✅ Tests (test)**：测试相关
+- **🔧 Chores (chore)**：构建/工具变更
+- **💥 BREAKING CHANGES**：破坏性变更
+
+### 第三步：生成 Changelog
+
+**格式标准**：[Keep a Changelog](https://keepachangelog.com/)
+
+\`\`\`markdown
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [版本号] - YYYY-MM-DD
+
+### Added（新增）
+- 新功能 1 (#PR号)
+- 新功能 2 by @contributor
+
+### Changed（变更）
+- 修改的功能 1
+- 修改的功能 2
+
+### Deprecated（废弃）
+- 即将移除的功能
+
+### Removed（移除）
+- 已移除的功能
+
+### Fixed（修复）
+- Bug 修复 1 (#issue号)
+- Bug 修复 2
+
+### Security（安全）
+- 安全漏洞修复
+
+## [上一个版本] - YYYY-MM-DD
+
+...
+\`\`\`
+
+---
+
+## Changelog 模板
+
+\`\`\`markdown
+# Changelog
+
+## [${version || "1.2.0"}] - ${new Date().toISOString().split('T')[0]}
+
+### ✨ Added
+- 新增用户认证功能 (#123) [@contributor1]
+- 新增数据导出功能 (#125)
+- 新增邮件通知系统
+
+### 🔄 Changed
+- 优化数据库查询性能 (#130)
+- 更新 UI 设计风格
+- 升级依赖包到最新版本
+
+### 🗑️ Deprecated
+- \`oldAPI()\` 方法即将在 v2.0 中移除，请使用 \`newAPI()\`
+
+### ❌ Removed
+- 移除了废弃的 \`legacyFeature\`
+- 删除了未使用的配置项
+
+### 🐛 Fixed
+- 修复登录页面样式错误 (#128)
+- 修复数据分页显示问题 (#132)
+- 修复内存泄漏问题 (#135)
+
+### 🔒 Security
+- 修复 SQL 注入漏洞 (CVE-2024-XXXX)
+- 更新依赖以修复安全漏洞
+
+### 💥 BREAKING CHANGES
+- API 端点从 \`/api/v1/users\` 改为 \`/api/v2/users\`
+- 配置文件格式从 JSON 改为 YAML
+- 最低 Node.js 版本要求提升到 18.x
+
+### 📚 Documentation
+- 更新 README 文档
+- 添加 API 使用指南
+- 完善贡献指南
+
+### 🏗️ Infrastructure
+- 升级 CI/CD 流程
+- 添加 Docker 支持
+- 配置自动化测试
+
+### 👥 Contributors
+感谢以下贡献者：
+- @contributor1 - 3 commits
+- @contributor2 - 2 commits
+- @contributor3 - 1 commit
+
+**Full Changelog**: https://github.com/owner/repo/compare/v1.1.0...v${version || "1.2.0"}
+\`\`\`
+
+---
+
+## Changelog 最佳实践
+
+### 内容要求
+
+1. **明确说明变更**
+   - 用户能理解的语言（避免技术术语）
+   - 说明影响范围
+   - 提供迁移指南（破坏性变更）
+
+2. **链接相关 Issue/PR**
+   - 使用 (#123) 格式
+   - 方便追溯详细信息
+
+3. **归功贡献者**
+   - 使用 @username 格式
+   - 体现团队协作
+
+### 版本规范
+
+**语义化版本 (Semantic Versioning)**：
+- **Major (X.0.0)**：破坏性变更
+- **Minor (x.X.0)**：新功能（向后兼容）
+- **Patch (x.x.X)**：Bug 修复
+
+### 发布流程
+
+1. 更新 CHANGELOG.md
+2. 更新 package.json 版本号
+3. 创建 Git tag：\`git tag -a v1.2.0 -m "Release v1.2.0"\`
+4. 推送 tag：\`git push origin v1.2.0\`
+5. 发布 GitHub Release
+
+---
+
+## 自动化工具
+
+**推荐工具**：
+- **standard-version**：自动生成 changelog
+- **conventional-changelog**：基于 commit 生成
+- **semantic-release**：自动发布版本
+
+**使用示例**：
+\`\`\`bash
+# 安装
+npm install -D standard-version
+
+# 生成 changelog
+npx standard-version
+
+# 首次发布
+npx standard-version --first-release
+\`\`\`
+
+---
+
+---
+
+## ⚠️ 边界约束
+
+- ❌ 仅输出 CHANGELOG 文本，不自动写入文件
+- ❌ 不执行 git 命令
+- ✅ 输出完整的 CHANGELOG Markdown
+
+现在请根据 commit 历史生成详细的 CHANGELOG.md 内容。`;
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: message,
+                },
+            ],
+        };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `❌ 生成 Changelog 失败: ${errorMessage}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+}

package/build/tools/gencommit.js

@@ -50,66 +50,66 @@ function buildTextGuide(changes) {
             ],
         outputs: ["一份规范说明文档，供 AI 直接据此写出最终 commit message"],
     });
-    return `${header}请按以下规则生成 Git commit message：
-
-**定位**
-- 本工具返回的是说明文档，不是最终 commit message
-- AI 必须根据本说明和变更内容，直接写出最终提交消息
-- 不要重复调用 gencommit
-- 不要说“工具返回为空”
-- 不要忽略本工具约定后自行发挥
-
-**强约束**
-- type 和 emoji 必须使用下方固定映射，不允许自创、不允许替换
-- 如果语义接近多个 type，选择最贴近本次主要变更的一种，不输出多个候选
-- 最终必须只输出一条 commit message 本体
-- 除非用户明确要求，否则不要附加解释、分析过程、前缀说明、代码块外文本
-- 如果缺少足够变更信息，先索取变更信息；不要猜测最终 commit message
-
-**第一步：获取变更信息**
-${changes ? `已提供变更内容：\n${changes}` : `
-1. 执行 \`git status\` 查看修改文件
-2. 执行 \`git diff\` 查看具体变更
-3. 如有暂存文件，执行 \`git diff --staged\`
-`}
-
-**第二步：分析变更**
-- 识别变更类型（新功能、修复、重构等）
-- 选择对应 emoji
-- 提炼一句中文 subject
-- 如有必要，在 body 中说明影响模块、关键改动和原因
-
-**第三步：输出最终 commit message**
-- 直接输出最终结果
-- 不要附加“根据 gencommit 规则生成如下”这类解释
-- 不要输出多条候选，默认只给一条最合适的
-- 不要自创新的 type 或 emoji
-- 不要把示例原样复用到当前提交
-
-**格式**
-\`\`\`
-<type>: <emoji> <subject>
-
-<body>
-
-<footer>
-\`\`\`
-
-**允许的 type**
-${ALLOWED_TYPES.map((item) => `- ${item.type} ${item.emoji}: ${item.when}`).join("\n")}
-
-**硬性规则**
-1. type 后面加冒号和空格，再接 emoji
-2. subject 使用中文，简洁明确，尽量不超过 50 字
-3. body 可选，但有必要时应说明影响范围和关键改动
-4. footer 可选，用于 issue / BREAKING CHANGE
-5. 最终只输出 commit message 本体
-6. 不允许使用固定映射之外的 type / emoji
-7. \`fixed\` 与 \`fix\` 都可用，但语义都表示“修复”；若无兼容性要求，优先用 \`fixed\`
-8. 若本次提交以文档、样式、测试、依赖调整为主，不要误用 \`feat\` 或 \`fixed\`
-
-**参考示例**
-${EXAMPLES.map((item) => `\`\`\`gitcommit\n${item.fullMessage}\n\`\`\``).join("\n\n")}
+    return `${header}请按以下规则生成 Git commit message：
+
+**定位**
+- 本工具返回的是说明文档，不是最终 commit message
+- AI 必须根据本说明和变更内容，直接写出最终提交消息
+- 不要重复调用 gencommit
+- 不要说“工具返回为空”
+- 不要忽略本工具约定后自行发挥
+
+**强约束**
+- type 和 emoji 必须使用下方固定映射，不允许自创、不允许替换
+- 如果语义接近多个 type，选择最贴近本次主要变更的一种，不输出多个候选
+- 最终必须只输出一条 commit message 本体
+- 除非用户明确要求，否则不要附加解释、分析过程、前缀说明、代码块外文本
+- 如果缺少足够变更信息，先索取变更信息；不要猜测最终 commit message
+
+**第一步：获取变更信息**
+${changes ? `已提供变更内容：\n${changes}` : `
+1. 执行 \`git status\` 查看修改文件
+2. 执行 \`git diff\` 查看具体变更
+3. 如有暂存文件，执行 \`git diff --staged\`
+`}
+
+**第二步：分析变更**
+- 识别变更类型（新功能、修复、重构等）
+- 选择对应 emoji
+- 提炼一句中文 subject
+- 如有必要，在 body 中说明影响模块、关键改动和原因
+
+**第三步：输出最终 commit message**
+- 直接输出最终结果
+- 不要附加“根据 gencommit 规则生成如下”这类解释
+- 不要输出多条候选，默认只给一条最合适的
+- 不要自创新的 type 或 emoji
+- 不要把示例原样复用到当前提交
+
+**格式**
+\`\`\`
+<type>: <emoji> <subject>
+
+<body>
+
+<footer>
+\`\`\`
+
+**允许的 type**
+${ALLOWED_TYPES.map((item) => `- ${item.type} ${item.emoji}: ${item.when}`).join("\n")}
+
+**硬性规则**
+1. type 后面加冒号和空格，再接 emoji
+2. subject 使用中文，简洁明确，尽量不超过 50 字
+3. body 可选，但有必要时应说明影响范围和关键改动
+4. footer 可选，用于 issue / BREAKING CHANGE
+5. 最终只输出 commit message 本体
+6. 不允许使用固定映射之外的 type / emoji
+7. \`fixed\` 与 \`fix\` 都可用，但语义都表示“修复”；若无兼容性要求，优先用 \`fixed\`
+8. 若本次提交以文档、样式、测试、依赖调整为主，不要误用 \`feat\` 或 \`fixed\`
+
+**参考示例**
+${EXAMPLES.map((item) => `\`\`\`gitcommit\n${item.fullMessage}\n\`\`\``).join("\n\n")}
 `;
 }
 export async function gencommit(args) {

package/build/tools/gendoc.d.ts

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