MCP Probe Kit

Instructions

Implementation Reference

• src/tools/gentest.ts:2-157 (handler)

  The gentest tool handler function. It takes args with code and optional framework, constructs a detailed prompt for generating comprehensive test cases (unit, integration, edge, error cases) following AAA pattern, with mocks, data factories, etc., and returns it as MCP content.

  export async function gentest(args: any) {
    try {
      const code = args?.code || "";
      const framework = args?.framework || "jest"; // jest, vitest, mocha
  
      const message = `请为以下代码生成完整的测试用例：
  
  📝 **代码内容**：
  ${code || "请提供需要测试的代码"}
  
  🧪 **测试框架**：${framework}
  
  ---
  
  ## 测试用例生成指南
  
  ### 1️⃣ 测试策略
  
  **测试类型**：
  - **单元测试**：测试单个函数/方法
  - **集成测试**：测试模块间交互
  - **边界测试**：测试极端情况
  - **异常测试**：测试错误处理
  
  **覆盖维度**：
  - ✅ 正常情况（Happy Path）
  - ✅ 边界条件（Boundary Conditions）
  - ✅ 异常情况（Error Cases）
  - ✅ 空值/特殊值（Null/Special Values）
  
  ### 2️⃣ 测试用例模板
  
  **测试结构（AAA 模式）**：
  \`\`\`typescript
  describe('函数/模块名称', () => {
    // Arrange - 准备测试数据
    // Act - 执行被测试的代码
    // Assert - 验证结果
    
    test('描述测试场景', () => {
      // Arrange
      const input = ...;
      const expected = ...;
      
      // Act
      const result = functionUnderTest(input);
      
      // Assert
      expect(result).toBe(expected);
    });
  });
  \`\`\`
  
  ### 3️⃣ 测试用例清单
  
  **正常情况测试**：
  - [ ] 基本功能正常工作
  - [ ] 返回值类型正确
  - [ ] 副作用符合预期
  
  **边界条件测试**：
  - [ ] 空输入（null, undefined, "", [], {}）
  - [ ] 最小值/最大值
  - [ ] 边界临界值
  
  **异常情况测试**：
  - [ ] 无效输入
  - [ ] 类型错误
  - [ ] 超出范围
  - [ ] 异常抛出正确
  
  **性能测试（可选）**：
  - [ ] 大数据量处理
  - [ ] 时间复杂度验证
  
  ### 4️⃣ Mock 和 Stub
  
  **需要 Mock 的场景**：
  - API 调用
  - 数据库操作
  - 文件系统操作
  - 时间相关函数
  - 随机数生成
  - 外部依赖
  
  **Mock 示例**：
  \`\`\`typescript
  // Mock 函数
  const mockFetch = jest.fn();
  
  // Mock 模块
  jest.mock('./api', () => ({
    fetchUser: jest.fn().mockResolvedValue({ id: 1, name: 'Test' })
  }));
  
  // Mock 时间
  jest.useFakeTimers();
  \`\`\`
  
  ### 5️⃣ 测试数据
  
  **测试数据原则**：
  - 使用有意义的测试数据
  - 避免硬编码，使用工厂函数
  - 覆盖各种数据类型
  - 准备充分的边界数据
  
  **数据工厂示例**：
  \`\`\`typescript
  const createUser = (overrides = {}) => ({
    id: 1,
    name: 'Test User',
    email: 'test@example.com',
    ...overrides
  });
  \`\`\`
  
  ---
  
  ## 测试文件命名规范
  
  - **单元测试**：\`functionName.test.ts\` 或 \`functionName.spec.ts\`
  - **集成测试**：\`moduleName.integration.test.ts\`
  - **E2E 测试**：\`feature.e2e.test.ts\`
  
  ---
  
  现在请生成完整的测试代码，包括：
  1. describe 块组织
  2. 所有必要的测试用例
  3. Mock/Stub 设置
  4. 测试数据准备
  5. 清晰的注释说明`;
  
      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,
      };
    }
  }

• src/index.ts:158-175 (schema)

  Schema definition for the gentest tool in the ListTools response, specifying input parameters: code (string) and framework (string, default jest).

  {
    name: "gentest",
    description: "【生成测试】为代码生成完整的测试用例（支持 Jest/Vitest/Mocha）",
    inputSchema: {
      type: "object",
      properties: {
        code: {
          type: "string",
          description: "需要测试的代码",
        },
        framework: {
          type: "string",
          description: "测试框架：jest, vitest, mocha（默认 jest）",
        },
      },
      required: [],
    },
  },

• src/index.ts:480-481 (registration)

  Registration in the CallToolRequestHandler switch statement: dispatches to the gentest function when tool name is 'gentest'.

  case "gentest":
    return await gentest(args);

• src/tools/index.ts:8-8 (registration)

  Export of the gentest handler from src/tools/index.ts, allowing import in src/index.ts.

  export { gentest } from "./gentest.js";

• src/index.ts:12-15 (registration)

  Import of gentest function from tools/index.js into the main index.ts for use in tool handlers.

    detectShell, initSetting, initProject, gencommit, debug, genapi,
    codeReview, gentest, genpr, checkDeps, gendoc, genchangelog, refactor, perf,
    fix, gensql, resolveConflict, genui, explain, convert, genreadme, split, analyzeProject
  } from "./tools/index.js";