mcp-probe-kit 1.8.0 → 1.8.1

package/docs/specs/gen-mock/requirements.md

@@ -1,137 +0,0 @@
-# 需求文档：gen_mock
-
-## 功能概述
-
-`gen_mock` 是一个 MCP 工具，用于根据数据结构或 API 定义生成 Mock 数据。支持多种数据格式和自定义规则。
-
-## 术语定义
-
-- **Mock_Data**: 模拟数据，用于测试和开发的假数据
-- **Schema**: 数据结构定义，描述数据的字段和类型
-- **Faker**: 假数据生成库，生成逼真的随机数据
-- **Seed**: 随机种子，用于生成可重复的数据
-
----
-
-## 需求列表
-
-### 需求 1: 根据 TypeScript 接口生成 Mock
-
-**用户故事:** 作为开发者，我想要根据 TypeScript 接口生成 Mock 数据，以便快速进行前端开发。
-
-#### 验收标准
-
-1. WHEN 用户提供 TypeScript interface THEN 工具 SHALL 生成符合接口的 Mock 数据
-2. THE 工具 SHALL 识别以下类型：
-   - 基础类型：string, number, boolean
-   - 复合类型：array, object
-   - 特殊类型：Date, enum, union
-3. THE 工具 SHALL 根据字段名智能生成数据（如 email 生成邮箱格式）
-
----
-
-### 需求 2: 根据 JSON Schema 生成 Mock
-
-**用户故事:** 作为开发者，我想要根据 JSON Schema 生成 Mock 数据，以便测试 API。
-
-#### 验收标准
-
-1. WHEN 用户提供 JSON Schema THEN 工具 SHALL 生成符合 Schema 的数据
-2. THE 工具 SHALL 支持 JSON Schema Draft-07 规范
-3. THE 工具 SHALL 处理 required、enum、pattern 等约束
-
----
-
-### 需求 3: 支持自定义生成规则
-
-**用户故事:** 作为开发者，我想要自定义数据生成规则，以便生成符合业务场景的数据。
-
-#### 验收标准
-
-1. THE 工具 SHALL 支持以下自定义规则：
-   - 指定字段的固定值
-   - 指定字段的取值范围
-   - 指定字段的格式（正则）
-   - 指定数组长度
-2. THE 工具 SHALL 支持中文数据生成
-3. THE 工具 SHALL 支持指定 locale（zh-CN, en-US 等）
-
----
-
-### 需求 4: 批量生成数据
-
-**用户故事:** 作为开发者，我想要批量生成多条 Mock 数据，以便进行压力测试。
-
-#### 验收标准
-
-1. WHEN 用户指定 count 参数 THEN 工具 SHALL 生成指定数量的数据
-2. THE 工具 SHALL 支持生成 1-1000 条数据
-3. THE 工具 SHALL 确保批量数据的多样性
-
----
-
-### 需求 5: 输出多种格式
-
-**用户故事:** 作为开发者，我想要输出不同格式的 Mock 数据，以便适应不同使用场景。
-
-#### 验收标准
-
-1. THE 工具 SHALL 支持以下输出格式：
-   - JSON
-   - TypeScript 对象
-   - JavaScript 对象
-   - CSV（表格数据）
-2. THE 工具 SHALL 默认输出 JSON 格式
-
----
-
-### 需求 6: 生成关联数据
-
-**用户故事:** 作为开发者，我想要生成有关联关系的数据，以便模拟真实的数据库场景。
-
-#### 验收标准
-
-1. THE 工具 SHALL 支持外键关联
-2. THE 工具 SHALL 支持一对多、多对多关系
-3. THE 工具 SHALL 确保关联数据的一致性
-
----
-
-## 非功能需求
-
-### 性能要求
-- 生成 100 条数据应小于 500ms
-
-### 数据质量要求
-- 生成的数据应符合字段语义
-- 支持可重复生成（通过 seed）
-
----
-
-## 输入输出规格
-
-### 输入参数
-
-| 参数名 | 类型 | 必填 | 默认值 | 描述 |
-|--------|------|------|--------|------|
-| schema | string | 是 | - | 数据结构定义（TS interface 或 JSON Schema） |
-| count | number | 否 | 1 | 生成数量 |
-| format | string | 否 | json | 输出格式 |
-| locale | string | 否 | zh-CN | 语言区域 |
-| seed | number | 否 | - | 随机种子 |
-
-### 输出格式
-
-```typescript
-{
-  content: [{
-    type: "text",
-    text: "生成的 Mock 数据"
-  }]
-}
-```
-
----
-
-*文档版本: 1.0.0*
-*创建时间: 2025-01-14*

package/docs/specs/gen-mock/tasks.md

@@ -1,66 +0,0 @@
-# 任务清单：gen_mock
-
-## 概述
-
-实现 `gen_mock` MCP 工具，用于根据数据结构生成 Mock 数据。
-
----
-
-## 任务列表
-
-### 阶段 1: 创建工具文件
-
-- [x] 1.1 创建 `src/tools/gen_mock.ts` 文件
-  - 创建文件结构
-  - 定义接口类型
-  - 实现参数验证
-  - 实现主函数框架
-  - _需求: 1.1-1.3, 4.1-4.3_
-
-- [x] 1.2 编写提示词模板
-  - 实现 PROMPT_TEMPLATE 常量
-  - 包含字段语义识别规则
-  - 包含类型映射表
-  - 包含输出格式模板
-  - 包含中英文数据示例
-  - _需求: 1.1-6.3_
-
----
-
-### 阶段 2: 注册工具
-
-- [x] 2.1 在 `src/tools/index.ts` 中导出工具
-  - 添加 export 语句
-
-- [x] 2.2 在 `src/index.ts` 中注册工具
-  - 添加工具定义（name, description, inputSchema）
-  - 添加工具处理逻辑（switch case）
-
----
-
-### 阶段 3: 测试验证
-
-- [x] 3.1 编译项目
-  - 运行 `npm run build`
-  - 确保无编译错误
-
-- [ ] 3.2 功能测试
-  - 测试 TypeScript interface 输入
-  - 测试 JSON Schema 输入
-  - 测试批量生成
-  - 测试不同输出格式
-
----
-
-## 文件变更清单
-
-| 文件 | 操作 | 说明 |
-|------|------|------|
-| src/tools/gen_mock.ts | 新建 | 工具实现 |
-| src/tools/index.ts | 修改 | 添加导出 |
-| src/index.ts | 修改 | 注册工具 |
-
----
-
-*任务版本: 1.0.0*
-*创建时间: 2025-01-14*

package/docs/specs/init-project-context/design.md

@@ -1,515 +0,0 @@
-# 设计文档：init_project_context
-
-## 概述
-
-`init_project_context` 工具采用"指令生成器"模式，返回详细的项目分析指南，由 AI 执行实际的分析和文档生成工作。
-
-## 设计原则
-
-### 1. 指令生成器模式
-- 工具不直接操作文件系统
-- 返回结构化的指令文本
-- AI 根据指令执行操作
-
-### 2. 提示词设计原则
-- **清晰性**: 每个步骤都有明确的目标和操作
-- **结构化**: 使用 Markdown 格式，层级分明
-- **通用性**: 兼容多种 AI 模型
-- **可执行性**: 每个步骤都是可操作的
-
----
-
-## 架构设计
-
-### 工具结构
-
-```
-src/tools/init_project_context.ts
-├── initProjectContext(args)     # 主函数
-│   ├── 解析参数
-│   ├── 构建指南文本
-│   └── 返回结果
-└── 常量定义
-    ├── DEFAULT_DOCS_DIR         # 默认文档目录
-    └── PROMPT_TEMPLATE          # 提示词模板
-```
-
-### 数据流
-
-```
-用户调用工具
-    ↓
-解析参数（docs_dir）
-    ↓
-构建指南文本（替换占位符）
-    ↓
-返回 MCP 响应
-    ↓
-AI 执行指南中的步骤
-    ↓
-生成 docs/project-context.md
-```
-
----
-
-## 提示词模板设计
-
-### 模板结构
-
-```markdown
-# 项目上下文初始化指南
-
-## 🎯 任务目标
-[明确说明要完成的任务]
-
-## 📋 执行步骤
-[分步骤的详细指南]
-
-### 步骤 1: [步骤名称]
-[具体操作说明]
-
-### 步骤 2: [步骤名称]
-[具体操作说明]
-
-...
-
-## 📝 文档模板
-[标准化的文档模板]
-
-## ✅ 检查清单
-[质量验证清单]
-```
-
-### 提示词设计要点
-
-#### 1. 任务目标（清晰明确）
-```markdown
-## 🎯 任务目标
-
-在 `{docs_dir}/` 目录下生成 `project-context.md` 文件。
-
-**输出文件**: `{docs_dir}/project-context.md`
-
-**文件用途**: 记录项目的核心信息，供后续功能开发时参考。
-```
-
-#### 2. 执行步骤（结构化、可操作）
-```markdown
-## 📋 执行步骤
-
-### 步骤 1: 分析技术栈
-
-**目标**: 识别项目使用的语言、框架和工具。
-
-**操作**:
-1. 读取 `package.json` 文件
-2. 从 `dependencies` 中识别框架（React、Vue、Express 等）
-3. 从 `devDependencies` 中识别构建工具（TypeScript、Webpack 等）
-4. 检查是否存在 `tsconfig.json`（判断是否使用 TypeScript）
-
-**输出**: 记录以下信息
-- 语言: JavaScript / TypeScript
-- 框架: [识别的框架]
-- 构建工具: [识别的工具]
-```
-
-#### 3. 文档模板（标准化、有占位符）
-```markdown
-## 📝 文档模板
-
-请在 `{docs_dir}/project-context.md` 中生成以下内容：
-
-\`\`\`markdown
-# 项目上下文
-
-## 项目概览
-
-| 属性 | 值 |
-|------|-----|
-| 名称 | [从 package.json 的 name 字段读取] |
-| 版本 | [从 package.json 的 version 字段读取] |
-| 类型 | [分析得出: Web应用/API服务/CLI工具/库] |
-| 描述 | [从 package.json 的 description 字段读取] |
-
-## 技术栈
-
-| 类别 | 技术 |
-|------|------|
-| 语言 | [JavaScript/TypeScript] |
-| 运行时 | [Node.js/Browser/Deno] |
-| 框架 | [识别的框架] |
-| 构建工具 | [识别的构建工具] |
-| 包管理器 | [npm/yarn/pnpm] |
-
-...
-\`\`\`
-```
-
-#### 4. 检查清单（可验证）
-```markdown
-## ✅ 检查清单
-
-生成文档后，请验证以下内容：
-
-- [ ] 文件已创建在正确的位置: `{docs_dir}/project-context.md`
-- [ ] 项目概览信息完整（名称、版本、类型、描述）
-- [ ] 技术栈信息准确（语言、框架、构建工具）
-- [ ] 目录结构清晰（深度 2-3 层）
-- [ ] 依赖列表完整（主要依赖已列出）
-- [ ] 所有占位符都已替换为实际内容
-- [ ] Markdown 格式正确，无语法错误
-```
-
----
-
-## 完整提示词模板
-
-```typescript
-const PROMPT_TEMPLATE = `
-# 项目上下文初始化指南
-
-## 🎯 任务目标
-
-在 \`{docs_dir}/\` 目录下生成 \`project-context.md\` 文件，记录项目的核心信息。
-
-**输出文件**: \`{docs_dir}/project-context.md\`
-
----
-
-## 📋 执行步骤
-
-请按照以下步骤分析项目并生成文档：
-
-### 步骤 1: 分析技术栈
-
-**目标**: 识别项目使用的语言、框架和工具。
-
-**操作**:
-1. 读取 \`package.json\` 文件
-2. 从 \`dependencies\` 中识别主要框架:
-   - React、Vue、Angular → 前端框架
-   - Express、Koa、Fastify → 后端框架
-   - Next.js、Nuxt.js → 全栈框架
-3. 从 \`devDependencies\` 中识别开发工具:
-   - typescript → TypeScript 项目
-   - webpack、vite、rollup → 构建工具
-   - jest、vitest、mocha → 测试框架
-4. 检查配置文件:
-   - \`tsconfig.json\` → TypeScript 配置
-   - \`vite.config.js\` → Vite 项目
-   - \`webpack.config.js\` → Webpack 项目
-
-**记录**: 语言、框架、构建工具、测试框架
-
----
-
-### 步骤 2: 分析项目结构
-
-**目标**: 理解项目的目录组织方式。
-
-**操作**:
-1. 列出项目根目录下的文件和文件夹
-2. 重点关注以下目录:
-   - \`src/\` → 源代码目录
-   - \`lib/\` → 库代码目录
-   - \`tests/\` 或 \`__tests__/\` → 测试目录
-   - \`docs/\` → 文档目录
-3. 识别入口文件:
-   - \`src/index.ts\` 或 \`src/index.js\`
-   - \`src/main.ts\` 或 \`src/main.js\`
-   - \`src/app.ts\` 或 \`src/app.js\`
-4. 生成目录树（深度 2-3 层，忽略 node_modules）
-
-**记录**: 目录结构、入口文件、主要模块
-
----
-
-### 步骤 3: 分析编码规范
-
-**目标**: 识别项目的代码风格和规范。
-
-**操作**:
-1. 检查是否存在以下配置文件:
-   - \`.eslintrc\` 或 \`.eslintrc.js\` → ESLint 配置
-   - \`.prettierrc\` 或 \`.prettierrc.js\` → Prettier 配置
-   - \`tsconfig.json\` → TypeScript 严格模式
-2. 从现有代码中识别命名规范:
-   - 文件命名: kebab-case / camelCase / PascalCase
-   - 变量命名: camelCase
-   - 常量命名: UPPER_SNAKE_CASE
-3. 检查 TypeScript 配置:
-   - \`strict\` 是否为 true
-   - 其他重要配置项
-
-**记录**: 代码风格工具、命名规范、TypeScript 配置
-
----
-
-### 步骤 4: 分析依赖
-
-**目标**: 列出项目的主要依赖。
-
-**操作**:
-1. 从 \`package.json\` 读取 \`dependencies\`
-2. 从 \`package.json\` 读取 \`devDependencies\`
-3. 识别关键依赖（框架、工具库、UI 库等）
-4. 统计依赖数量
-
-**记录**: 主要生产依赖、主要开发依赖、依赖总数
-
----
-
-### 步骤 5: 分析开发流程
-
-**目标**: 识别项目的开发、构建、测试命令。
-
-**操作**:
-1. 从 \`package.json\` 读取 \`scripts\` 字段
-2. 识别常用命令:
-   - \`dev\` 或 \`start\` → 开发启动命令
-   - \`build\` → 构建命令
-   - \`test\` → 测试命令
-   - \`lint\` → 代码检查命令
-
-**记录**: 开发命令、构建命令、测试命令
-
----
-
-## 📝 文档模板
-
-请在 \`{docs_dir}/project-context.md\` 中生成以下内容：
-
-\`\`\`markdown
-# 项目上下文
-
-> 本文档由 MCP Probe Kit 的 init_project_context 工具生成，记录项目的核心信息。
-
-## 项目概览
-
-| 属性 | 值 |
-|------|-----|
-| 名称 | [从 package.json 读取] |
-| 版本 | [从 package.json 读取] |
-| 类型 | [Web应用 / API服务 / CLI工具 / 库 / MCP服务器] |
-| 描述 | [从 package.json 读取] |
-
-## 技术栈
-
-| 类别 | 技术 |
-|------|------|
-| 语言 | [JavaScript / TypeScript] |
-| 运行时 | [Node.js / Browser / Deno] |
-| 框架 | [识别的框架，如 React、Express] |
-| 构建工具 | [识别的工具，如 TypeScript、Webpack] |
-| 包管理器 | [npm / yarn / pnpm] |
-| 测试框架 | [识别的测试框架，如 Jest、Vitest] |
-
-## 项目结构
-
-\\\`\\\`\\\`
-[生成目录树，深度 2-3 层]
-[示例:]
-project/
-├── src/
-│   ├── index.ts
-│   └── tools/
-├── tests/
-├── docs/
-├── package.json
-└── tsconfig.json
-\\\`\\\`\\\`
-
-### 主要目录说明
-
-| 目录 | 用途 |
-|------|------|
-| src/ | [源代码目录] |
-| tests/ | [测试代码目录] |
-| docs/ | [文档目录] |
-
-### 入口文件
-
-- 主入口: \`[入口文件路径]\`
-
-## 架构模式
-
-- **设计模式**: [识别的模式，如 MVC、组件化、服务层]
-- **模块划分**: [主要模块说明]
-
-## 编码规范
-
-### 代码风格
-
-| 工具 | 配置 |
-|------|------|
-| ESLint | [是否使用，配置文件] |
-| Prettier | [是否使用，配置文件] |
-
-### 命名规范
-
-| 类型 | 规范 |
-|------|------|
-| 文件命名 | [kebab-case / camelCase / PascalCase] |
-| 变量命名 | [camelCase] |
-| 常量命名 | [UPPER_SNAKE_CASE] |
-| 函数命名 | [camelCase] |
-
-### TypeScript 配置
-
-- strict 模式: [是 / 否]
-- 其他重要配置: [列出]
-
-## 依赖管理
-
-### 主要生产依赖
-
-| 依赖 | 用途 |
-|------|------|
-| [依赖名] | [用途说明] |
-
-### 主要开发依赖
-
-| 依赖 | 用途 |
-|------|------|
-| [依赖名] | [用途说明] |
-
-### 依赖统计
-
-- 生产依赖: [数量] 个
-- 开发依赖: [数量] 个
-- 总计: [数量] 个
-
-## 开发流程
-
-### 常用命令
-
-| 命令 | 用途 |
-|------|------|
-| \`npm run dev\` | [开发启动] |
-| \`npm run build\` | [构建] |
-| \`npm test\` | [测试] |
-| \`npm run lint\` | [代码检查] |
-
----
-
-*生成时间: [当前时间]*
-*生成工具: MCP Probe Kit - init_project_context*
-\`\`\`
-
----
-
-## ✅ 检查清单
-
-生成文档后，请验证以下内容：
-
-- [ ] 文件已创建: \`{docs_dir}/project-context.md\`
-- [ ] 项目概览完整（名称、版本、类型、描述都已填写）
-- [ ] 技术栈准确（语言、框架、构建工具正确识别）
-- [ ] 目录结构清晰（树形结构正确，深度适当）
-- [ ] 入口文件正确（主入口文件已识别）
-- [ ] 编码规范完整（ESLint、Prettier、命名规范已记录）
-- [ ] 依赖列表完整（主要依赖已列出并说明用途）
-- [ ] 开发命令正确（dev、build、test 命令已记录）
-- [ ] 所有占位符已替换（没有 [xxx] 格式的占位符）
-- [ ] Markdown 格式正确（表格、代码块格式正确）
-
----
-
-## 📌 注意事项
-
-1. **如果某项信息无法获取**，请填写 "未配置" 或 "无"，不要留空
-2. **目录树生成时**，忽略 \`node_modules\`、\`.git\`、\`dist\`、\`build\` 等目录
-3. **依赖说明**，只列出主要依赖（前 10 个），其他可省略
-4. **时间格式**，使用 ISO 格式或本地格式均可
-
----
-
-*指南版本: 1.0.0*
-`;
-```
-
----
-
-## 接口设计
-
-### 函数签名
-
-```typescript
-interface InitProjectContextArgs {
-  docs_dir?: string;  // 默认 "docs"
-}
-
-interface MCPResponse {
-  content: Array<{
-    type: "text";
-    text: string;
-  }>;
-  isError?: boolean;
-}
-
-async function initProjectContext(args: InitProjectContextArgs): Promise<MCPResponse>
-```
-
-### 实现伪代码
-
-```typescript
-export async function initProjectContext(args: any): Promise<MCPResponse> {
-  try {
-    // 1. 解析参数
-    const docsDir = args?.docs_dir || "docs";
-    
-    // 2. 构建指南文本（替换占位符）
-    const guide = PROMPT_TEMPLATE
-      .replace(/{docs_dir}/g, docsDir);
-    
-    // 3. 返回结果
-    return {
-      content: [{
-        type: "text",
-        text: guide
-      }]
-    };
-  } catch (error) {
-    return {
-      content: [{
-        type: "text",
-        text: `❌ 初始化项目上下文失败: ${error}`
-      }],
-      isError: true
-    };
-  }
-}
-```
-
----
-
-## 测试用例
-
-### 测试 1: 默认参数
-
-```typescript
-// 输入
-initProjectContext({})
-
-// 期望输出
-// - 返回包含 "docs/project-context.md" 的指南
-// - 指南包含所有必要的步骤
-// - 指南包含文档模板
-// - 指南包含检查清单
-```
-
-### 测试 2: 自定义目录
-
-```typescript
-// 输入
-initProjectContext({ docs_dir: "documentation" })
-
-// 期望输出
-// - 返回包含 "documentation/project-context.md" 的指南
-// - 所有路径都使用 "documentation" 而不是 "docs"
-```
-
----
-
-*设计版本: 1.0.0*
-*创建时间: 2025-01-14*