mcp-probe-kit 1.15.1 → 2.0.0

package/build/tools/gencommit.d.ts

@@ -1,10 +1,4 @@
-export declare function gencommit(args: any): Promise<{
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError?: undefined;
-} | {
+export declare function gencommit(args: any): Promise<import("../lib/response.js").ToolResponse | {
     content: {
         type: string;
         text: string;

package/build/tools/gencommit.js

@@ -1,4 +1,6 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
+import { okStructured } from "../lib/response.js";
+import { CommitMessageSchema } from "../schemas/structured-output.js";
 // gencommit 工具实现
 export async function gencommit(args) {
     try {
@@ -25,7 +27,7 @@ export async function gencommit(args) {
         if (input) {
             changes = input;
         }
-        const message = `请按以下步骤生成规范的 Git commit 消息：
+        const textMessage = `请按以下步骤生成规范的 Git commit 消息：
 
 **第一步：获取变更信息**
 ${changes ? `已提供变更内容：\n${changes}` : `
@@ -109,19 +111,25 @@ chore: 🤖 升级依赖版本至 1.2.9
 💡 **提示**：
 - 如果暂存区为空，提示用户先使用 \`git add\` 添加文件
 - 如果变更较多，建议分多次提交
-- 确保 commit 消息清晰描述了"做了什么"和"为什么"
-
----
-
-现在请开始执行上述步骤。`;
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: message,
-                },
-            ],
+- 确保 commit 消息清晰描述了"做了什么"和"为什么"`;
+        // 创建示例结构化数据（用于演示格式）
+        // 注意：实际的 commit 数据应该由 AI 根据实际变更生成
+        const exampleCommitData = {
+            type: type || 'feat',
+            scope: '',
+            subject: '示例：添加新功能',
+            body: '这是一个示例 commit 消息\n\n实际使用时，AI 会根据代码变更生成真实的 commit 内容',
+            footer: '',
+            fullMessage: 'feat: 🎸 示例：添加新功能\n\n这是一个示例 commit 消息\n\n实际使用时，AI 会根据代码变更生成真实的 commit 内容',
+            emoji: '🎸',
         };
+        // 返回结构化输出
+        // textMessage 提供人类可读的指导信息
+        // exampleCommitData 提供结构化数据示例（AI 会根据实际情况生成真实数据）
+        return okStructured(textMessage, exampleCommitData, {
+            schema: CommitMessageSchema,
+            note: 'AI 应该根据实际代码变更生成真实的 commit 数据，而不是使用这个示例',
+        });
     }
     catch (error) {
         const errorMessage = error instanceof Error ? error.message : String(error);

package/build/tools/gendoc.d.ts

@@ -1,13 +1 @@
-export declare function gendoc(args: any): Promise<{
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError?: undefined;
-} | {
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError: boolean;
-}>;
+export declare function gendoc(args: any): Promise<import("../lib/response.js").ToolResponse>;

package/build/tools/gendoc.js

@@ -1,4 +1,5 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
+import { okStructured } from "../lib/response.js";
 // gendoc 工具实现
 export async function gendoc(args) {
     try {
@@ -208,25 +209,27 @@ type TypeName = {
 2. 复杂逻辑的行内注释
 3. 使用示例
 4. 特殊情况说明`;
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: message,
-                },
-            ],
+        // 创建结构化数据对象
+        const documentation = {
+            summary: `为代码生成 ${style} 风格的${lang === "zh" ? "中文" : "英文"}注释`,
+            docType: style,
+            documentation: message,
+            functions: [],
         };
+        return okStructured(message, documentation, {
+            schema: (await import("../schemas/output/generation-tools.js")).DocumentationSchema,
+        });
     }
     catch (error) {
         const errorMessage = error instanceof Error ? error.message : String(error);
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: `❌ 生成注释失败: ${errorMessage}`,
-                },
-            ],
-            isError: true,
+        const errorData = {
+            summary: `生成注释失败: ${errorMessage}`,
+            docType: 'jsdoc',
+            documentation: '',
+            functions: [],
         };
+        return okStructured(`❌ 生成注释失败: ${errorMessage}`, errorData, {
+            schema: (await import("../schemas/output/generation-tools.js")).DocumentationSchema,
+        });
     }
 }

package/build/tools/genpr.d.ts

@@ -1,13 +1 @@
-export declare function genpr(args: any): Promise<{
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError?: undefined;
-} | {
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError: boolean;
-}>;
+export declare function genpr(args: any): Promise<import("../lib/response.js").ToolResponse>;

package/build/tools/genpr.js

@@ -1,4 +1,5 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
+import { okStructured } from "../lib/response.js";
 // genpr 工具实现
 export async function genpr(args) {
     try {
@@ -28,167 +29,37 @@ ${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,
-                },
-            ],
+请生成完整的 PR 描述，包括：
+
+1. **变更说明** - 概述和详细变更内容
+2. **解决的问题** - 关联的 Issue
+3. **技术细节** - 主要修改和架构变更
+4. **测试计划** - 测试覆盖情况
+5. **注意事项** - 破坏性变更、部署注意事项
+6. **Checklist** - 代码审查清单
+
+**重要**: 请使用结构化输出格式返回结果。`;
+        // 创建结构化数据对象
+        const structuredData = {
+            summary: `生成 ${branch || "分支"} 的 PR 描述`,
+            title: "", // AI 将填充 PR 标题
+            description: "", // AI 将填充 PR 描述
+            type: "feature", // AI 将根据内容判断类型
         };
+        return okStructured(message, structuredData, {
+            schema: (await import("../schemas/output/generation-tools.js")).PullRequestSchema,
+        });
     }
     catch (error) {
         const errorMessage = error instanceof Error ? error.message : String(error);
-        return {
-            content: [
-                {
-                    type: "text",
-                    text: `❌ 生成 PR 描述失败: ${errorMessage}`,
-                },
-            ],
-            isError: true,
+        const errorData = {
+            summary: "PR 描述生成失败",
+            title: "",
+            description: "",
+            type: "feature",
         };
+        return okStructured(`❌ 生成 PR 描述失败: ${errorMessage}`, errorData, {
+            schema: (await import("../schemas/output/generation-tools.js")).PullRequestSchema,
+        });
     }
 }

package/build/tools/genreadme.d.ts

@@ -1,13 +1 @@
-export declare function genreadme(args: any): Promise<{
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError?: undefined;
-} | {
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError: boolean;
-}>;
+export declare function genreadme(args: any): Promise<import("../lib/response.js").ToolResponse>;