mcp-probe-kit 1.15.1 → 2.0.0

package/build/tools/security_scan.js

@@ -273,6 +273,7 @@ logger.info("API call with token:", maskToken(apiToken))
 *工具: MCP Probe Kit - security_scan*
 `;
 import { parseArgs, getString } from "../utils/parseArgs.js";
+import { okStructured } from "../lib/response.js";
 /**
  * security_scan 工具实现
  */
@@ -309,15 +310,25 @@ export async function securityScan(args) {
             .replace(/{code}/g, code)
             .replace(/{language}/g, language)
             .replace(/{scan_type}/g, scanTypeDesc[scanType] || scanType);
-        return {
-            content: [{ type: "text", text: guide }],
+        // 创建结构化数据对象
+        const securityReport = {
+            summary: `安全扫描 - ${scanTypeDesc[scanType] || scanType}`,
+            overallRisk: 'medium',
+            vulnerabilities: [],
         };
+        return okStructured(guide, securityReport, {
+            schema: (await import('../schemas/output/core-tools.js')).SecurityReportSchema,
+        });
     }
     catch (error) {
         const errorMsg = error instanceof Error ? error.message : String(error);
-        return {
-            content: [{ type: "text", text: `❌ 安全扫描失败: ${errorMsg}` }],
-            isError: true,
+        const errorData = {
+            summary: `安全扫描失败: ${errorMsg}`,
+            overallRisk: 'none',
+            vulnerabilities: [],
         };
+        return okStructured(`❌ 安全扫描失败: ${errorMsg}`, errorData, {
+            schema: (await import('../schemas/output/core-tools.js')).SecurityReportSchema,
+        });
     }
 }

package/build/tools/start_api.d.ts

@@ -1,13 +1,7 @@
-export declare function startApi(args: any): Promise<{
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError?: undefined;
-} | {
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError: boolean;
-}>;
+/**
+ * start_api 智能编排工具
+ *
+ * 场景：API 开发
+ * 编排：[检查上下文] → genapi → gen_mock → gentest
+ */
+export declare function startApi(args: any): Promise<import("../lib/response.js").ToolResponse>;

package/build/tools/start_api.js

@@ -1,158 +1,11 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
+import { okStructured } from "../lib/response.js";
 /**
  * start_api 智能编排工具
  *
  * 场景：API 开发
  * 编排：[检查上下文] → genapi → gen_mock → gentest
  */
-const PROMPT_TEMPLATE = `# 🔌 API 开发编排指南
-
-## 🎯 目标
-
-为以下 API 代码生成完整的开发资料：
-
-\`\`\`{language}
-{code}
-\`\`\`
-
----
-
-## 📋 步骤 0: 项目上下文（自动处理）
-
-**操作**:
-1. 检查 \`docs/project-context.md\` 是否存在
-2. **如果不存在**：
-   - 调用 \`init_project_context\` 工具
-   - 等待生成完成
-3. **读取** \`docs/project-context.md\` 内容
-4. 了解项目的 API 规范、测试框架
-
----
-
-## 📝 步骤 1: 生成 API 文档
-
-**调用工具**: \`genapi\`
-
-**参数**:
-\`\`\`json
-{
-  "code": "[API 代码]",
-  "format": "{format}"
-}
-\`\`\`
-
-**生成内容**:
-- API 端点列表
-- 请求/响应格式
-- 参数说明
-- 示例
-
-**产出**: API 文档（Markdown/OpenAPI/JSDoc）
-
----
-
-## 🎭 步骤 2: 生成 Mock 数据
-
-**调用工具**: \`gen_mock\`
-
-**参数**:
-\`\`\`json
-{
-  "schema": "[从 API 代码中提取的数据结构]",
-  "count": 5,
-  "format": "json",
-  "locale": "zh-CN"
-}
-\`\`\`
-
-**生成内容**:
-- 请求示例数据
-- 响应示例数据
-- 各种场景的测试数据
-
-**产出**: Mock 数据文件
-
----
-
-## 🧪 步骤 3: 生成 API 测试
-
-**调用工具**: \`gentest\`
-
-**参数**:
-\`\`\`json
-{
-  "code": "[API 代码]",
-  "framework": "[根据项目上下文选择]"
-}
-\`\`\`
-
-**生成内容**:
-- 单元测试
-- 集成测试
-- 边界情况测试
-- 错误处理测试
-
-**产出**: 测试代码
-
----
-
-## ✅ 完成检查
-
-- [ ] 项目上下文已读取
-- [ ] API 文档已生成
-- [ ] Mock 数据已生成
-- [ ] 测试代码已生成
-
----
-
-## 📊 输出汇总
-
-完成后，向用户提供：
-
-### 1. API 文档
-
-\`\`\`markdown
-## API 端点
-
-### [METHOD] /path
-
-**描述**: ...
-
-**请求参数**:
-| 参数 | 类型 | 必填 | 说明 |
-|------|------|------|------|
-
-**响应**:
-\`\`\`json
-{
-  "code": 0,
-  "data": {}
-}
-\`\`\`
-\`\`\`
-
-### 2. Mock 数据
-
-\`\`\`json
-[Mock 数据示例]
-\`\`\`
-
-### 3. 测试代码
-
-\`\`\`typescript
-[测试代码]
-\`\`\`
-
-### 4. 使用建议
-
-- Mock 数据可用于前端开发联调
-- 测试代码可直接运行验证 API
-- API 文档可分享给前端/调用方
-
----
-
-*编排工具: MCP Probe Kit - start_api*
-`;
 export async function startApi(args) {
     try {
         // 智能参数解析，支持自然语言输入
@@ -175,19 +28,78 @@ export async function startApi(args) {
         if (!code) {
             throw new Error("缺少必填参数: code（API 代码）");
         }
-        const guide = PROMPT_TEMPLATE
-            .replace(/{code}/g, code)
-            .replace(/{language}/g, language)
-            .replace(/{format}/g, format);
-        return {
-            content: [{ type: "text", text: guide }],
+        const message = `# 🔌 API 开发编排
+
+为以下 API 代码生成完整的开发资料：
+
+\`\`\`${language}
+${code}
+\`\`\`
+
+---
+
+## 📋 执行步骤
+
+### 步骤 1: 生成 API 文档
+调用 \`genapi\` 工具，生成 API 端点列表、请求/响应格式、参数说明和示例。
+
+### 步骤 2: 生成 Mock 数据
+调用 \`gen_mock\` 工具，生成请求示例数据、响应示例数据和各种场景的测试数据。
+
+### 步骤 3: 生成 API 测试
+调用 \`gentest\` 工具，生成单元测试、集成测试、边界情况测试和错误处理测试。
+
+---
+
+## 📊 输出内容
+
+完成后，提供：
+1. API 文档（${format} 格式）
+2. Mock 数据
+3. 测试代码
+4. 使用建议
+
+**重要**: 请使用结构化输出格式返回结果。`;
+        // 创建结构化数据对象
+        const structuredData = {
+            summary: "API 开发编排",
+            status: "pending",
+            steps: [
+                {
+                    name: "genapi",
+                    description: "生成 API 文档",
+                    status: "pending",
+                },
+                {
+                    name: "gen_mock",
+                    description: "生成 Mock 数据",
+                    status: "pending",
+                },
+                {
+                    name: "gentest",
+                    description: "生成 API 测试",
+                    status: "pending",
+                },
+            ],
+            apiDocumentation: {}, // AI 将填充实际的 API 文档
+            endpoints: [], // AI 将填充端点列表
         };
+        return okStructured(message, structuredData, {
+            schema: (await import("../schemas/output/workflow-tools.js")).APIWorkflowSchema,
+        });
     }
     catch (error) {
         const errorMsg = error instanceof Error ? error.message : String(error);
-        return {
-            content: [{ type: "text", text: `❌ 编排执行失败: ${errorMsg}` }],
-            isError: true,
+        const errorData = {
+            summary: "API 开发失败",
+            status: "failed",
+            steps: [],
+            apiDocumentation: {},
+            endpoints: [],
+            warnings: [errorMsg],
         };
+        return okStructured(`❌ 编排执行失败: ${errorMsg}`, errorData, {
+            schema: (await import("../schemas/output/workflow-tools.js")).APIWorkflowSchema,
+        });
     }
 }

package/build/tools/start_bugfix.d.ts

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

package/build/tools/start_bugfix.js

@@ -1,4 +1,6 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
+import { okStructured } from "../lib/response.js";
+import { BugFixReportSchema } from "../schemas/structured-output.js";
 /**
  * start_bugfix 智能编排工具
  *
@@ -126,9 +128,43 @@ export async function startBugfix(args) {
             .replace(/{error_message}/g, errorMessage)
             .replace(/{stack_trace}/g, stackTrace)
             .replace(/{stack_trace_section}/g, stackTraceSection);
-        return {
-            content: [{ type: "text", text: guide }],
+        // 创建结构化的 Bug 修复报告
+        const bugfixReport = {
+            summary: `Bug 修复工作流：${errorMessage.substring(0, 50)}${errorMessage.length > 50 ? '...' : ''}`,
+            status: 'pending',
+            steps: [
+                {
+                    name: '检查项目上下文',
+                    status: 'pending',
+                    description: '检查 docs/project-context.md 是否存在，如不存在则调用 init_project_context',
+                },
+                {
+                    name: 'Bug 分析与修复',
+                    status: 'pending',
+                    description: '调用 fix_bug 工具进行问题定位和修复',
+                },
+                {
+                    name: '生成回归测试',
+                    status: 'pending',
+                    description: '调用 gentest 工具生成测试用例',
+                },
+            ],
+            artifacts: [],
+            nextSteps: [
+                '检查并读取项目上下文文档',
+                '调用 fix_bug 工具分析和修复问题',
+                '调用 gentest 工具生成回归测试',
+                '运行测试验证修复',
+            ],
+            rootCause: '待分析（需要调用 fix_bug 工具）',
+            fixPlan: '待制定（需要调用 fix_bug 工具）',
+            testPlan: '待生成（需要调用 gentest 工具）',
+            affectedFiles: [],
         };
+        return okStructured(guide, bugfixReport, {
+            schema: BugFixReportSchema,
+            note: 'AI 应该按照指南执行步骤，并在每个步骤完成后更新 structuredContent 中的状态',
+        });
     }
     catch (error) {
         const errorMsg = error instanceof Error ? error.message : String(error);

package/build/tools/start_doc.d.ts

@@ -1,13 +1,7 @@
-export declare function startDoc(args: any): Promise<{
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError?: undefined;
-} | {
-    content: {
-        type: string;
-        text: string;
-    }[];
-    isError: boolean;
-}>;
+/**
+ * start_doc 智能编排工具
+ *
+ * 场景：文档生成
+ * 编排：[检查上下文] → gendoc → genreadme → genapi
+ */
+export declare function startDoc(args: any): Promise<import("../lib/response.js").ToolResponse>;

package/build/tools/start_doc.js

@@ -1,170 +1,11 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
+import { okStructured } from "../lib/response.js";
 /**
  * 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 {
         // 智能参数解析，支持自然语言输入
@@ -189,19 +30,85 @@ export async function startDoc(args) {
         if (!code) {
             throw new Error("缺少必填参数: code 或 project_info");
         }
-        const guide = PROMPT_TEMPLATE
-            .replace(/{code}/g, code)
-            .replace(/{style}/g, style)
-            .replace(/{lang}/g, lang);
-        return {
-            content: [{ type: "text", text: guide }],
+        const message = `# 📖 文档生成编排
+
+为项目/代码生成完整的文档
+
+**输入内容**:
+\`\`\`
+${code}
+\`\`\`
+
+---
+
+## 📋 执行步骤
+
+### 步骤 1: 生成代码注释
+调用 \`gendoc\` 工具，生成函数/方法注释、参数说明、返回值说明和使用示例。
+
+### 步骤 2: 生成 README
+调用 \`genreadme\` 工具，生成项目简介、功能特性、安装使用、API 说明和贡献指南。
+
+### 步骤 3: 生成 API 文档（如适用）
+调用 \`genapi\` 工具，生成 API 端点列表、请求/响应格式和参数说明。
+
+---
+
+## 📊 输出内容
+
+完成后，提供：
+1. 代码注释（${style} 风格）
+2. README.md
+3. API 文档（如适用）
+4. 文档清单
+
+**重要**: 请使用结构化输出格式返回结果。`;
+        // 创建结构化数据对象
+        const structuredData = {
+            summary: "文档生成编排",
+            status: "pending",
+            steps: [
+                {
+                    name: "gendoc",
+                    description: "生成代码注释",
+                    status: "pending",
+                },
+                {
+                    name: "genreadme",
+                    description: "生成 README",
+                    status: "pending",
+                },
+                {
+                    name: "genapi",
+                    description: "生成 API 文档",
+                    status: "pending",
+                },
+            ],
+            coverage: {
+                functions: 0,
+                classes: 0,
+                modules: 0,
+            },
         };
+        return okStructured(message, structuredData, {
+            schema: (await import("../schemas/output/workflow-tools.js")).DocWorkflowSchema,
+        });
     }
     catch (error) {
         const errorMsg = error instanceof Error ? error.message : String(error);
-        return {
-            content: [{ type: "text", text: `❌ 编排执行失败: ${errorMsg}` }],
-            isError: true,
+        const errorData = {
+            summary: "文档生成失败",
+            status: "failed",
+            steps: [],
+            coverage: {
+                functions: 0,
+                classes: 0,
+                modules: 0,
+            },
+            warnings: [errorMsg],
         };
+        return okStructured(`❌ 编排执行失败: ${errorMsg}`, errorData, {
+            schema: (await import("../schemas/output/workflow-tools.js")).DocWorkflowSchema,
+        });
     }
 }

package/build/tools/start_feature.d.ts

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