mcp-probe-kit 3.0.0 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +423 -410
  2. package/build/index.js +4 -1
  3. package/build/lib/response.d.ts +9 -0
  4. package/build/lib/response.js +23 -0
  5. package/build/schemas/git-tools.d.ts +26 -0
  6. package/build/schemas/git-tools.js +43 -0
  7. package/build/schemas/index.d.ts +26 -0
  8. package/build/tools/__tests__/git_work_report.test.d.ts +1 -0
  9. package/build/tools/__tests__/git_work_report.test.js +70 -0
  10. package/build/tools/add_feature.js +3 -42
  11. package/build/tools/code_review.js +6 -14
  12. package/build/tools/estimate.d.ts +7 -1
  13. package/build/tools/estimate.js +5 -36
  14. package/build/tools/fix_bug.js +6 -16
  15. package/build/tools/gencommit.js +16 -26
  16. package/build/tools/gentest.js +34 -35
  17. package/build/tools/git_work_report.d.ts +21 -0
  18. package/build/tools/git_work_report.js +226 -0
  19. package/build/tools/index.d.ts +1 -0
  20. package/build/tools/index.js +2 -0
  21. package/build/tools/refactor.js +24 -16
  22. package/docs/assets/js/tailwind.js +83 -0
  23. package/docs/data/tools.js +22 -0
  24. package/docs/index.html +207 -493
  25. package/docs/pages/all-tools.html +223 -708
  26. package/docs/pages/examples.html +463 -561
  27. package/docs/pages/getting-started.html +573 -778
  28. package/docs/pages/migration.html +232 -273
  29. package/docs/project-context/architecture.md +0 -0
  30. package/docs/project-context/how-to-develop.md +313 -0
  31. package/docs/project-context/how-to-test.md +457 -0
  32. package/docs/project-context/tech-stack.md +96 -0
  33. package/docs/project-context.md +53 -0
  34. package/docs/specs/git-work-report/design.md +568 -0
  35. package/docs/specs/git-work-report/requirements.md +131 -0
  36. package/docs/specs/git-work-report/tasks.md +197 -0
  37. package/package.json +79 -79
  38. package/docs/fix-summary.md +0 -110
  39. package/docs/mobile-test.html +0 -101
  40. package/docs/styles/docs.css +0 -556
  41. package/docs/styles/page.css +0 -1148
package/README.md CHANGED
@@ -1,410 +1,423 @@
1
- # MCP Probe Kit
2
-
3
- [![npm version](https://img.shields.io/npm/v/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
4
- [![npm downloads](https://img.shields.io/npm/dm/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
5
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
- [![GitHub stars](https://img.shields.io/github/stars/mybolide/mcp-probe-kit.svg)](https://github.com/mybolide/mcp-probe-kit/stargazers)
7
-
8
- > 🚀 AI 驱动的完整研发工具集 - 覆盖开发全流程
9
-
10
- 一个强大的 MCP (Model Context Protocol) 服务器,提供 **20 个精简工具**,覆盖从产品分析到最终发布的全流程(需求 → 设计 → 开发 → 质量 → 发布),所有工具支持**结构化输出**。
11
-
12
- **🎉 v3.0 重大更新**:精简工具数量,专注核心竞争力,消除选择困难,让 AI 做更多原生工作
13
-
14
- **支持所有 MCP 客户端**:Cursor、Claude Desktop、Cline、Continue 等
15
-
16
- **协议版本**:MCP 2025-11-25 · **SDK**:@modelcontextprotocol/sdk 1.25.3
17
-
18
- ---
19
-
20
- ## 📚 完整文档
21
-
22
- **👉 [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)**
23
-
24
- - [快速开始](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html) - 5分钟完成安装配置
25
- - [所有工具](https://mcp-probe-kit.bytezonex.com/pages/all-tools.html) - 20个工具完整列表
26
- - [最佳实践](https://mcp-probe-kit.bytezonex.com/pages/examples.html) - 完整研发流程实战指南
27
- - [v3.0 迁移指南](https://mcp-probe-kit.bytezonex.com/pages/migration.html) - v2.x → v3.0 升级指南
28
-
29
- ---
30
-
31
- ## ✨ 核心特性
32
-
33
- ### 📦 20 个精简工具
34
-
35
- - **🔄 工作流编排** (6个) - 一键完成复杂开发流程
36
- - `start_feature`, `start_bugfix`, `start_onboard`, `start_ui`, `start_product`, `start_ralph`
37
- - **🔍 代码分析** (3个) - 代码质量与重构
38
- - `code_review`, `fix_bug`, `refactor`
39
- - **� Git 工具** (1个) - 提交消息生成
40
- - `gencommit`
41
- - **⚡ 代码生成** (1个) - 测试生成
42
- - `gentest`
43
- - **📦 项目管理** (7个) - 项目初始化与需求管理
44
- - `init_project`, `init_project_context`, `add_feature`, `estimate`, `interview`, `ask_user`
45
- - **🎨 UI/UX 工具** (3个) - 设计系统与数据同步
46
- - `ui_design_system`, `ui_search`, `sync_ui_data`
47
-
48
- ### 🎯 结构化输出
49
-
50
- 核心与编排工具支持**结构化输出**,返回机器可读的 JSON 数据,提高 AI 解析准确性,支持工具串联和状态追踪。
51
-
52
- ### 🧭 委托式编排协议(Delegated Plan)
53
-
54
- 所有 `start_*` 编排工具会在 `structuredContent.metadata.plan` 中返回**执行计划**。
55
- AI 需要**按步骤调用工具并落盘文件**,而不是由工具内部直接执行。
56
-
57
- **Plan Schema(核心字段)**:
58
- ```json
59
- {
60
- "mode": "delegated",
61
- "steps": [
62
- {
63
- "id": "spec",
64
- "tool": "add_feature",
65
- "args": { "feature_name": "user-auth", "description": "用户认证功能" },
66
- "outputs": ["docs/specs/user-auth/requirements.md"]
67
- }
68
- ]
69
- }
70
- ```
71
-
72
- **字段说明**:
73
- - `mode`: 固定为 `delegated`
74
- - `steps`: 执行步骤数组
75
- - `tool`: 工具名称(如 `add_feature`)
76
- - `action`: 无工具时的手动动作描述(如 `update_project_context`)
77
- - `args`: 工具参数
78
- - `outputs`: 预期产物
79
- - `when/dependsOn/note`: 可选的条件与说明
80
-
81
- ### 🧩 结构化输出字段规范(关键字段)
82
-
83
- 编排与原子工具都会返回 `structuredContent`,常用字段约定如下:
84
- - `summary`: 一句话摘要
85
- - `status`: 状态(pending/success/failed/partial)
86
- - `steps`: 执行步骤(编排工具)
87
- - `artifacts`: 产物列表(路径 + 用途)
88
- - `metadata.plan`: 委托式执行计划(仅 start_*)
89
- - `specArtifacts`: 规格文档产物(start_feature)
90
- - `estimate`: 估算结果(start_feature / estimate)
91
-
92
- ### 🧠 需求澄清模式(Requirements Loop)
93
-
94
- 当需求不够清晰时,可在 `start_feature / start_bugfix / start_ui` 中使用 `requirements_mode=loop`。
95
- 该模式会先进行 1-2 轮结构化澄清,再进入规格/修复/UI 执行流程。
96
-
97
- **示例:**
98
- ```json
99
- {
100
- "feature_name": "user-auth",
101
- "description": "用户认证功能",
102
- "requirements_mode": "loop",
103
- "loop_max_rounds": 2,
104
- "loop_question_budget": 5
105
- }
106
- ```
107
-
108
- ### 🧩 模板系统(普通模型友好)
109
-
110
- `add_feature` 支持模板档位,默认 `auto` 自动选择:需求不完整时偏向 `guided`(包含更详细的填写规则与检查清单),需求较完整时选择 `strict`(结构更紧凑,适合高能力模型或归档场景)。
111
-
112
- **示例:**
113
- ```json
114
- {
115
- "description": "添加用户认证功能",
116
- "template_profile": "auto"
117
- }
118
- ```
119
-
120
- **适用工具**:
121
- - `start_feature` 会透传 `template_profile` 给 `add_feature`
122
- - `start_bugfix` / `start_ui` 也支持 `template_profile`,用于控制指导强度(auto/guided/strict)
123
-
124
- **模板档位策略**:
125
- - `guided`:需求信息少/不完整、普通模型优先
126
- - `strict`:需求已结构化、希望指引更紧凑
127
- - `auto`:默认推荐,自动选择 guided/strict
128
-
129
- ### 🔄 工作流编排
130
-
131
- 6 个智能编排工具,自动组合多个基础工具,一键完成复杂开发流程:
132
- - `start_feature` - 新功能开发(需求 → 设计 → 估算)
133
- - `start_bugfix` - Bug 修复(分析 → 修复 → 测试)
134
- - `start_onboard` - 项目上手(生成项目上下文文档)
135
- - `start_ui` - UI 开发(设计系统 → 组件 → 代码)
136
- - `start_product` - 产品设计(PRD → 原型 → 设计系统 → HTML)
137
- - `start_ralph` - Ralph Loop(循环开发直到目标完成)
138
-
139
- ### 🚀 产品设计工作流
140
-
141
- `start_product` 是一个完整的产品设计编排工具,从需求到可交互原型:
142
-
143
- **工作流程:**
144
- 1. **需求分析** - 生成标准 PRD 文档(产品概述、功能需求、页面清单)
145
- 2. **原型设计** - 为每个页面生成详细的原型文档
146
- 3. **设计系统** - 基于产品类型生成设计规范
147
- 4. **HTML 原型** - 生成可直接在浏览器中查看的交互原型
148
- 5. **项目上下文** - 自动更新项目文档
149
-
150
- **结构化输出补充**:
151
- - `start_product.structuredContent.artifacts`:产出物列表(PRD、原型、设计系统等)
152
- - `interview.structuredContent.mode`:`usage` / `questions` / `record`
153
-
154
- ### 🎨 UI/UX Pro Max
155
-
156
- 3 个 UI/UX 工具,`start_ui` 作为统一入口:
157
- - `start_ui` - 一键 UI 开发(支持智能模式)(编排工具)
158
- - `ui_design_system` - 智能设计系统生成
159
- - `ui_search` - UI/UX 数据搜索(BM25 算法)
160
- - `sync_ui_data` - 同步最新 UI/UX 数据到本地
161
-
162
- **注意**:`start_ui` 会自动调用 `ui_design_system` 和 `ui_search`,您无需单独调用它们。
163
-
164
- **灵感来源:**
165
- - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX 设计系统理念
166
- - [json-render](https://github.com/vercel-labs/json-render) - JSON 模板渲染引擎
167
-
168
- **为什么使用 `sync_ui_data`?**
169
-
170
- 我们的 `start_ui` 工具依赖丰富的 UI/UX 数据库(颜色、图标、图表、组件、设计模式等)来生成高质量的设计系统和代码。这些数据来自 npm 包 [uipro-cli](https://www.npmjs.com/package/uipro-cli),包含:
171
- - 🎨 颜色方案(主流品牌色、配色方案)
172
- - 🔣 图标库(React Icons、Heroicons 等)
173
- - 📊 图表组件(Recharts、Chart.js 等)
174
- - 🎯 落地页模板(SaaS、电商、政府等)
175
- - 📐 设计规范(间距、字体、阴影等)
176
-
177
- **数据同步策略:**
178
- 1. **内嵌数据**:构建时同步,离线可用
179
- 2. **缓存数据**:运行时更新到 `~/.mcp-probe-kit/ui-ux-data/`
180
- 3. **手动同步**:使用 `sync_ui_data` 强制更新最新数据
181
-
182
- 这确保了即使在离线环境下,`start_ui` 也能生成专业级的 UI 代码。
183
-
184
- ### 🎤 需求访谈
185
-
186
- 2 个访谈工具,在开发前澄清需求:
187
- - `interview` - 结构化需求访谈
188
- - `ask_user` - AI 主动提问
189
-
190
- ---
191
-
192
- ## 🧭 工具选择指南
193
-
194
- ### 何时使用编排工具 vs 单独工具?
195
-
196
- **使用编排工具(start_*)当:**
197
- - ✅ 需要完整的工作流程(多个步骤)
198
- - ✅ 希望自动化执行多个任务
199
- - ✅ 需要生成多个产物(文档、代码、测试等)
200
-
201
- **使用单独工具当:**
202
- - ✅ 只需要某个特定功能
203
- - ✅ 已经有了项目上下文文档
204
- - ✅ 需要更精细的控制
205
-
206
- ### 常见场景选择
207
-
208
- | 场景 | 推荐工具 | 原因 |
209
- |------|---------|------|
210
- | 开发新功能(完整流程) | `start_feature` | 自动完成:规格→估算 |
211
- | 只需要功能规格文档 | `add_feature` | 更轻量,只生成文档 |
212
- | 修复 Bug(完整流程) | `start_bugfix` | 自动完成:分析→修复→测试 |
213
- | 只需要 Bug 分析 | `fix_bug` | 更快速,只分析问题 |
214
- | 生成设计系统 | `ui_design_system` | 直接生成设计规范 |
215
- | 开发 UI 组件 | `start_ui` | 完整流程:设计→组件→代码 |
216
- | 产品设计(从需求到原型) | `start_product` | 一键完成:PRD→原型→HTML |
217
- | 一句话需求分析 | `init_project` | 生成完整项目规格文档 |
218
- | 项目上手文档 | `init_project_context` | 生成技术栈/架构/规范 |
219
-
220
- ---
221
-
222
- ## 🚀 快速开始
223
-
224
- ### 方式一:npx 直接使用(推荐)
225
-
226
- 无需安装,直接使用最新版本。
227
-
228
- #### Cursor / Cline 配置
229
-
230
- **配置文件位置:**
231
- - Windows: `%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`
232
- - macOS: `~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
233
- - Linux: `~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
234
-
235
- **配置内容:**
236
- ```json
237
- {
238
- "mcpServers": {
239
- "mcp-probe-kit": {
240
- "command": "npx",
241
- "args": ["mcp-probe-kit@latest"]
242
- }
243
- }
244
- }
245
- ```
246
-
247
- #### Claude Desktop 配置
248
-
249
- **配置文件位置:**
250
- - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
251
- - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
252
- - Linux: `~/.config/Claude/claude_desktop_config.json`
253
-
254
- **配置内容:**
255
- ```json
256
- {
257
- "mcpServers": {
258
- "mcp-probe-kit": {
259
- "command": "npx",
260
- "args": ["-y", "mcp-probe-kit@latest"]
261
- }
262
- }
263
- }
264
- ```
265
-
266
- ### 方式二:全局安装
267
-
268
- ```bash
269
- npm install -g mcp-probe-kit
270
- ```
271
-
272
- 配置文件中使用:
273
- ```json
274
- {
275
- "mcpServers": {
276
- "mcp-probe-kit": {
277
- "command": "mcp-probe-kit"
278
- }
279
- }
280
- }
281
- ```
282
-
283
- ### 重启客户端
284
-
285
- 配置完成后,**完全退出并重新打开**你的 MCP 客户端。
286
-
287
- **👉 [详细安装指南](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
288
-
289
- ---
290
-
291
- ## 💡 使用示例
292
-
293
- ### 日常开发
294
- ```bash
295
- code_review @feature.ts # 代码审查
296
- gentest @feature.ts # 生成测试
297
- gencommit # 生成提交消息
298
- ```
299
-
300
- ### 新功能开发
301
- ```bash
302
- start_feature user-auth "用户认证功能"
303
- # 自动完成:需求分析 → 设计方案 → 工作量估算
304
- ```
305
-
306
- ### Bug 修复
307
- ```bash
308
- start_bugfix
309
- # 然后粘贴错误信息
310
- # 自动完成:问题定位 → 修复方案 → 测试代码
311
- ```
312
-
313
- ### 产品设计
314
- ```bash
315
- start_product "在线教育平台" --product_type=SaaS
316
- # 自动完成:PRD → 原型设计 → 设计系统 → HTML 原型
317
- ```
318
-
319
- ### UI 开发
320
- ```bash
321
- start_ui "登录页面" --mode=auto
322
- # 自动完成:设计系统 → 组件生成 → 代码输出
323
- ```
324
-
325
- ### 项目上下文文档
326
- ```bash
327
- # 单文件模式(默认)- 生成一个完整的 project-context.md
328
- init_project_context
329
-
330
- # 模块化模式 - 生成 6 个分类文档(适合大型项目)
331
- init_project_context --mode=modular
332
- # 生成:project-context.md(索引)+ 5 个分类文档
333
- ```
334
-
335
- **👉 [更多使用示例](https://mcp-probe-kit.bytezonex.com/pages/examples.html)**
336
-
337
- ---
338
-
339
- ## ❓ 常见问题
340
-
341
- ### Q1: 工具无法使用或报错怎么办?
342
-
343
- 查看详细日志:
344
-
345
- **Windows (PowerShell):**
346
- ```powershell
347
- npx -y mcp-probe-kit@latest 2>&1 | Tee-Object -FilePath .\mcp-probe-kit.log
348
- ```
349
-
350
- **macOS/Linux:**
351
- ```bash
352
- npx -y mcp-probe-kit@latest 2>&1 | tee ./mcp-probe-kit.log
353
- ```
354
-
355
- ### Q2: 配置后客户端无法识别工具?
356
-
357
- 1. **重启客户端**(完全退出后重新打开)
358
- 2. 检查配置文件路径是否正确
359
- 3. 确认 JSON 格式正确,没有语法错误
360
- 4. 查看客户端的开发者工具或日志中的错误信息
361
-
362
- ### Q3: 如何更新到最新版本?
363
-
364
- **npx 方式(推荐):**
365
- 配置中使用 `@latest` 标签,会自动使用最新版本。
366
-
367
- **全局安装方式:**
368
- ```bash
369
- npm update -g mcp-probe-kit
370
- ```
371
-
372
- **👉 [更多常见问题](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
373
-
374
- ---
375
-
376
- ## 🤝 贡献指南
377
-
378
- 欢迎提交 Issue 和 Pull Request!
379
-
380
- **改进建议:**
381
- - 新增实用工具
382
- - 优化现有工具的提示词
383
- - 改进文档和示例
384
- - 修复 Bug
385
-
386
- ---
387
-
388
- ## 📄 License
389
-
390
- MIT License
391
-
392
- ---
393
-
394
- ## 🔗 相关链接
395
-
396
- - **作者**: [小墨 (Kyle)](https://www.bytezonex.com/)
397
- - **GitHub**: [mcp-probe-kit](https://github.com/mybolide/mcp-probe-kit)
398
- - **npm**: [mcp-probe-kit](https://www.npmjs.com/package/mcp-probe-kit)
399
- - **文档**: [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)
400
-
401
- **相关项目:**
402
- - [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) - MCP 协议官方文档
403
- - [GitHub Spec-Kit](https://github.com/github/spec-kit) - GitHub 规格化开发工具
404
- - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX 设计系统理念来源
405
- - [json-render](https://github.com/vercel-labs/json-render) - JSON 模板渲染引擎灵感来源
406
- - [uipro-cli](https://www.npmjs.com/package/uipro-cli) - UI/UX 数据源
407
-
408
- ---
409
-
410
- **Made with ❤️ for AI-Powered Development**
1
+ # MCP Probe Kit
2
+
3
+ [![npm version](https://img.shields.io/npm/v/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
4
+ [![npm downloads](https://img.shields.io/npm/dm/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
+ [![GitHub stars](https://img.shields.io/github/stars/mybolide/mcp-probe-kit.svg)](https://github.com/mybolide/mcp-probe-kit/stargazers)
7
+
8
+ > 🚀 AI 驱动的完整研发工具集 - 覆盖开发全流程
9
+
10
+ 一个强大的 MCP (Model Context Protocol) 服务器,提供 **21 个工具**,覆盖从产品分析到最终发布的全流程(需求 → 设计 → 开发 → 质量 → 发布),所有工具支持**结构化输出**。
11
+
12
+ **🎉 v3.0 重大更新**:精简工具数量,专注核心竞争力,消除选择困难,让 AI 做更多原生工作
13
+
14
+ **支持所有 MCP 客户端**:Cursor、Claude Desktop、Cline、Continue 等
15
+
16
+ **协议版本**:MCP 2025-11-25 · **SDK**:@modelcontextprotocol/sdk 1.25.3
17
+
18
+ ---
19
+
20
+ ## 📚 完整文档
21
+
22
+ **👉 [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)**
23
+
24
+ - [快速开始](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html) - 5分钟完成安装配置
25
+ - [所有工具](https://mcp-probe-kit.bytezonex.com/pages/all-tools.html) - 20个工具完整列表
26
+ - [最佳实践](https://mcp-probe-kit.bytezonex.com/pages/examples.html) - 完整研发流程实战指南
27
+ - [v3.0 迁移指南](https://mcp-probe-kit.bytezonex.com/pages/migration.html) - v2.x → v3.0 升级指南
28
+
29
+ ---
30
+
31
+ ## ✨ 核心特性
32
+
33
+ ### 📦 21 个工具
34
+
35
+ - **🔄 工作流编排** (6个) - 一键完成复杂开发流程
36
+ - `start_feature`, `start_bugfix`, `start_onboard`, `start_ui`, `start_product`, `start_ralph`
37
+ - **🔍 代码分析** (3个) - 代码质量与重构
38
+ - `code_review`, `fix_bug`, `refactor`
39
+ - **📝 Git 工具** (2个) - Git 提交和工作报告
40
+ - `gencommit`, `git_work_report`
41
+ - **⚡ 代码生成** (1个) - 测试生成
42
+ - `gentest`
43
+ - **📦 项目管理** (7个) - 项目初始化与需求管理
44
+ - `init_project`, `init_project_context`, `add_feature`, `estimate`, `interview`, `ask_user`
45
+ - **🎨 UI/UX 工具** (3个) - 设计系统与数据同步
46
+ - `ui_design_system`, `ui_search`, `sync_ui_data`
47
+
48
+ ### 🎯 结构化输出
49
+
50
+ 核心与编排工具支持**结构化输出**,返回机器可读的 JSON 数据,提高 AI 解析准确性,支持工具串联和状态追踪。
51
+
52
+ ### 🧭 委托式编排协议(Delegated Plan)
53
+
54
+ 所有 `start_*` 编排工具会在 `structuredContent.metadata.plan` 中返回**执行计划**。
55
+ AI 需要**按步骤调用工具并落盘文件**,而不是由工具内部直接执行。
56
+
57
+ **Plan Schema(核心字段)**:
58
+ ```json
59
+ {
60
+ "mode": "delegated",
61
+ "steps": [
62
+ {
63
+ "id": "spec",
64
+ "tool": "add_feature",
65
+ "args": { "feature_name": "user-auth", "description": "用户认证功能" },
66
+ "outputs": ["docs/specs/user-auth/requirements.md"]
67
+ }
68
+ ]
69
+ }
70
+ ```
71
+
72
+ **字段说明**:
73
+ - `mode`: 固定为 `delegated`
74
+ - `steps`: 执行步骤数组
75
+ - `tool`: 工具名称(如 `add_feature`)
76
+ - `action`: 无工具时的手动动作描述(如 `update_project_context`)
77
+ - `args`: 工具参数
78
+ - `outputs`: 预期产物
79
+ - `when/dependsOn/note`: 可选的条件与说明
80
+
81
+ ### 🧩 结构化输出字段规范(关键字段)
82
+
83
+ 编排与原子工具都会返回 `structuredContent`,常用字段约定如下:
84
+ - `summary`: 一句话摘要
85
+ - `status`: 状态(pending/success/failed/partial)
86
+ - `steps`: 执行步骤(编排工具)
87
+ - `artifacts`: 产物列表(路径 + 用途)
88
+ - `metadata.plan`: 委托式执行计划(仅 start_*)
89
+ - `specArtifacts`: 规格文档产物(start_feature)
90
+ - `estimate`: 估算结果(start_feature / estimate)
91
+
92
+ ### 🧠 需求澄清模式(Requirements Loop)
93
+
94
+ 当需求不够清晰时,可在 `start_feature / start_bugfix / start_ui` 中使用 `requirements_mode=loop`。
95
+ 该模式会先进行 1-2 轮结构化澄清,再进入规格/修复/UI 执行流程。
96
+
97
+ **示例:**
98
+ ```json
99
+ {
100
+ "feature_name": "user-auth",
101
+ "description": "用户认证功能",
102
+ "requirements_mode": "loop",
103
+ "loop_max_rounds": 2,
104
+ "loop_question_budget": 5
105
+ }
106
+ ```
107
+
108
+ ### 🧩 模板系统(普通模型友好)
109
+
110
+ `add_feature` 支持模板档位,默认 `auto` 自动选择:需求不完整时偏向 `guided`(包含更详细的填写规则与检查清单),需求较完整时选择 `strict`(结构更紧凑,适合高能力模型或归档场景)。
111
+
112
+ **示例:**
113
+ ```json
114
+ {
115
+ "description": "添加用户认证功能",
116
+ "template_profile": "auto"
117
+ }
118
+ ```
119
+
120
+ **适用工具**:
121
+ - `start_feature` 会透传 `template_profile` 给 `add_feature`
122
+ - `start_bugfix` / `start_ui` 也支持 `template_profile`,用于控制指导强度(auto/guided/strict)
123
+
124
+ **模板档位策略**:
125
+ - `guided`:需求信息少/不完整、普通模型优先
126
+ - `strict`:需求已结构化、希望指引更紧凑
127
+ - `auto`:默认推荐,自动选择 guided/strict
128
+
129
+ ### 🔄 工作流编排
130
+
131
+ 6 个智能编排工具,自动组合多个基础工具,一键完成复杂开发流程:
132
+ - `start_feature` - 新功能开发(需求 → 设计 → 估算)
133
+ - `start_bugfix` - Bug 修复(分析 → 修复 → 测试)
134
+ - `start_onboard` - 项目上手(生成项目上下文文档)
135
+ - `start_ui` - UI 开发(设计系统 → 组件 → 代码)
136
+ - `start_product` - 产品设计(PRD → 原型 → 设计系统 → HTML)
137
+ - `start_ralph` - Ralph Loop(循环开发直到目标完成)
138
+
139
+ ### 🚀 产品设计工作流
140
+
141
+ `start_product` 是一个完整的产品设计编排工具,从需求到可交互原型:
142
+
143
+ **工作流程:**
144
+ 1. **需求分析** - 生成标准 PRD 文档(产品概述、功能需求、页面清单)
145
+ 2. **原型设计** - 为每个页面生成详细的原型文档
146
+ 3. **设计系统** - 基于产品类型生成设计规范
147
+ 4. **HTML 原型** - 生成可直接在浏览器中查看的交互原型
148
+ 5. **项目上下文** - 自动更新项目文档
149
+
150
+ **结构化输出补充**:
151
+ - `start_product.structuredContent.artifacts`:产出物列表(PRD、原型、设计系统等)
152
+ - `interview.structuredContent.mode`:`usage` / `questions` / `record`
153
+
154
+ ### 🎨 UI/UX Pro Max
155
+
156
+ 3 个 UI/UX 工具,`start_ui` 作为统一入口:
157
+ - `start_ui` - 一键 UI 开发(支持智能模式)(编排工具)
158
+ - `ui_design_system` - 智能设计系统生成
159
+ - `ui_search` - UI/UX 数据搜索(BM25 算法)
160
+ - `sync_ui_data` - 同步最新 UI/UX 数据到本地
161
+
162
+ **注意**:`start_ui` 会自动调用 `ui_design_system` 和 `ui_search`,您无需单独调用它们。
163
+
164
+ **灵感来源:**
165
+ - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX 设计系统理念
166
+ - [json-render](https://github.com/vercel-labs/json-render) - JSON 模板渲染引擎
167
+
168
+ **为什么使用 `sync_ui_data`?**
169
+
170
+ 我们的 `start_ui` 工具依赖丰富的 UI/UX 数据库(颜色、图标、图表、组件、设计模式等)来生成高质量的设计系统和代码。这些数据来自 npm 包 [uipro-cli](https://www.npmjs.com/package/uipro-cli),包含:
171
+ - 🎨 颜色方案(主流品牌色、配色方案)
172
+ - 🔣 图标库(React Icons、Heroicons 等)
173
+ - 📊 图表组件(Recharts、Chart.js 等)
174
+ - 🎯 落地页模板(SaaS、电商、政府等)
175
+ - 📐 设计规范(间距、字体、阴影等)
176
+
177
+ **数据同步策略:**
178
+ 1. **内嵌数据**:构建时同步,离线可用
179
+ 2. **缓存数据**:运行时更新到 `~/.mcp-probe-kit/ui-ux-data/`
180
+ 3. **手动同步**:使用 `sync_ui_data` 强制更新最新数据
181
+
182
+ 这确保了即使在离线环境下,`start_ui` 也能生成专业级的 UI 代码。
183
+
184
+ ### 🎤 需求访谈
185
+
186
+ 2 个访谈工具,在开发前澄清需求:
187
+ - `interview` - 结构化需求访谈
188
+ - `ask_user` - AI 主动提问
189
+
190
+ ---
191
+
192
+ ## 🧭 工具选择指南
193
+
194
+ ### 何时使用编排工具 vs 单独工具?
195
+
196
+ **使用编排工具(start_*)当:**
197
+ - ✅ 需要完整的工作流程(多个步骤)
198
+ - ✅ 希望自动化执行多个任务
199
+ - ✅ 需要生成多个产物(文档、代码、测试等)
200
+
201
+ **使用单独工具当:**
202
+ - ✅ 只需要某个特定功能
203
+ - ✅ 已经有了项目上下文文档
204
+ - ✅ 需要更精细的控制
205
+
206
+ ### 常见场景选择
207
+
208
+ | 场景 | 推荐工具 | 原因 |
209
+ |------|---------|------|
210
+ | 开发新功能(完整流程) | `start_feature` | 自动完成:规格→估算 |
211
+ | 只需要功能规格文档 | `add_feature` | 更轻量,只生成文档 |
212
+ | 修复 Bug(完整流程) | `start_bugfix` | 自动完成:分析→修复→测试 |
213
+ | 只需要 Bug 分析 | `fix_bug` | 更快速,只分析问题 |
214
+ | 生成设计系统 | `ui_design_system` | 直接生成设计规范 |
215
+ | 开发 UI 组件 | `start_ui` | 完整流程:设计→组件→代码 |
216
+ | 产品设计(从需求到原型) | `start_product` | 一键完成:PRD→原型→HTML |
217
+ | 一句话需求分析 | `init_project` | 生成完整项目规格文档 |
218
+ | 项目上手文档 | `init_project_context` | 生成技术栈/架构/规范 |
219
+
220
+ ---
221
+
222
+ ## 🚀 快速开始
223
+
224
+ ### 方式一:npx 直接使用(推荐)
225
+
226
+ 无需安装,直接使用最新版本。
227
+
228
+ #### Cursor / Cline 配置
229
+
230
+ **配置文件位置:**
231
+ - Windows: `%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`
232
+ - macOS: `~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
233
+ - Linux: `~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
234
+
235
+ **配置内容:**
236
+ ```json
237
+ {
238
+ "mcpServers": {
239
+ "mcp-probe-kit": {
240
+ "command": "npx",
241
+ "args": ["mcp-probe-kit@latest"]
242
+ }
243
+ }
244
+ }
245
+ ```
246
+
247
+ #### Claude Desktop 配置
248
+
249
+ **配置文件位置:**
250
+ - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
251
+ - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
252
+ - Linux: `~/.config/Claude/claude_desktop_config.json`
253
+
254
+ **配置内容:**
255
+ ```json
256
+ {
257
+ "mcpServers": {
258
+ "mcp-probe-kit": {
259
+ "command": "npx",
260
+ "args": ["-y", "mcp-probe-kit@latest"]
261
+ }
262
+ }
263
+ }
264
+ ```
265
+
266
+ ### 方式二:全局安装
267
+
268
+ ```bash
269
+ npm install -g mcp-probe-kit
270
+ ```
271
+
272
+ 配置文件中使用:
273
+ ```json
274
+ {
275
+ "mcpServers": {
276
+ "mcp-probe-kit": {
277
+ "command": "mcp-probe-kit"
278
+ }
279
+ }
280
+ }
281
+ ```
282
+
283
+ ### 重启客户端
284
+
285
+ 配置完成后,**完全退出并重新打开**你的 MCP 客户端。
286
+
287
+ **👉 [详细安装指南](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
288
+
289
+ ---
290
+
291
+ ## 💡 使用示例
292
+
293
+ ### 日常开发
294
+ ```bash
295
+ code_review @feature.ts # 代码审查
296
+ gentest @feature.ts # 生成测试
297
+ gencommit # 生成提交消息
298
+ ```
299
+
300
+ ### 新功能开发
301
+ ```bash
302
+ start_feature user-auth "用户认证功能"
303
+ # 自动完成:需求分析 → 设计方案 → 工作量估算
304
+ ```
305
+
306
+ ### Bug 修复
307
+ ```bash
308
+ start_bugfix
309
+ # 然后粘贴错误信息
310
+ # 自动完成:问题定位 → 修复方案 → 测试代码
311
+ ```
312
+
313
+ ### 产品设计
314
+ ```bash
315
+ start_product "在线教育平台" --product_type=SaaS
316
+ # 自动完成:PRD → 原型设计 → 设计系统 → HTML 原型
317
+ ```
318
+
319
+ ### UI 开发
320
+ ```bash
321
+ start_ui "登录页面" --mode=auto
322
+ # 自动完成:设计系统 → 组件生成 → 代码输出
323
+ ```
324
+
325
+ ### 项目上下文文档
326
+ ```bash
327
+ # 单文件模式(默认)- 生成一个完整的 project-context.md
328
+ init_project_context
329
+
330
+ # 模块化模式 - 生成 6 个分类文档(适合大型项目)
331
+ init_project_context --mode=modular
332
+ # 生成:project-context.md(索引)+ 5 个分类文档
333
+ ```
334
+
335
+ ### Git 工作报告
336
+ ```bash
337
+ # 生成日报
338
+ git_work_report --date 2026-1-27
339
+
340
+ # 生成周报
341
+ git_work_report --start_date 2026-2-1 --end_date 2026-2-6
342
+
343
+ # 保存到文件
344
+ git_work_report --date 2026-1-27 --output_file daily-report.md
345
+ # 自动分析 Git diff,生成简洁专业的中文工作报告
346
+ ```
347
+
348
+ **👉 [更多使用示例](https://mcp-probe-kit.bytezonex.com/pages/examples.html)**
349
+
350
+ ---
351
+
352
+ ## 常见问题
353
+
354
+ ### Q1: 工具无法使用或报错怎么办?
355
+
356
+ 查看详细日志:
357
+
358
+ **Windows (PowerShell):**
359
+ ```powershell
360
+ npx -y mcp-probe-kit@latest 2>&1 | Tee-Object -FilePath .\mcp-probe-kit.log
361
+ ```
362
+
363
+ **macOS/Linux:**
364
+ ```bash
365
+ npx -y mcp-probe-kit@latest 2>&1 | tee ./mcp-probe-kit.log
366
+ ```
367
+
368
+ ### Q2: 配置后客户端无法识别工具?
369
+
370
+ 1. **重启客户端**(完全退出后重新打开)
371
+ 2. 检查配置文件路径是否正确
372
+ 3. 确认 JSON 格式正确,没有语法错误
373
+ 4. 查看客户端的开发者工具或日志中的错误信息
374
+
375
+ ### Q3: 如何更新到最新版本?
376
+
377
+ **npx 方式(推荐):**
378
+ 配置中使用 `@latest` 标签,会自动使用最新版本。
379
+
380
+ **全局安装方式:**
381
+ ```bash
382
+ npm update -g mcp-probe-kit
383
+ ```
384
+
385
+ **👉 [更多常见问题](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
386
+
387
+ ---
388
+
389
+ ## 🤝 贡献指南
390
+
391
+ 欢迎提交 Issue 和 Pull Request!
392
+
393
+ **改进建议:**
394
+ - 新增实用工具
395
+ - 优化现有工具的提示词
396
+ - 改进文档和示例
397
+ - 修复 Bug
398
+
399
+ ---
400
+
401
+ ## 📄 License
402
+
403
+ MIT License
404
+
405
+ ---
406
+
407
+ ## 🔗 相关链接
408
+
409
+ - **作者**: [小墨 (Kyle)](https://www.bytezonex.com/)
410
+ - **GitHub**: [mcp-probe-kit](https://github.com/mybolide/mcp-probe-kit)
411
+ - **npm**: [mcp-probe-kit](https://www.npmjs.com/package/mcp-probe-kit)
412
+ - **文档**: [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)
413
+
414
+ **相关项目:**
415
+ - [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) - MCP 协议官方文档
416
+ - [GitHub Spec-Kit](https://github.com/github/spec-kit) - GitHub 规格化开发工具
417
+ - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX 设计系统理念来源
418
+ - [json-render](https://github.com/vercel-labs/json-render) - JSON 模板渲染引擎灵感来源
419
+ - [uipro-cli](https://www.npmjs.com/package/uipro-cli) - UI/UX 数据源
420
+
421
+ ---
422
+
423
+ **Made with ❤️ for AI-Powered Development**