mcp-probe-kit 1.15.0 → 2.0.0

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 (165) hide show
  1. package/README.md +113 -1642
  2. package/build/index.js +75 -42
  3. package/build/lib/elicitation-helper.d.ts +73 -0
  4. package/build/lib/elicitation-helper.js +130 -0
  5. package/build/lib/response.d.ts +32 -0
  6. package/build/lib/response.js +28 -0
  7. package/build/lib/tasks-manager.d.ts +116 -0
  8. package/build/lib/tasks-manager.js +217 -0
  9. package/build/lib/toolset-manager.d.ts +48 -0
  10. package/build/lib/toolset-manager.js +112 -0
  11. package/build/schemas/basic-tools.d.ts +0 -32
  12. package/build/schemas/basic-tools.js +0 -34
  13. package/build/schemas/code-analysis-tools.d.ts +0 -36
  14. package/build/schemas/code-analysis-tools.js +0 -38
  15. package/build/schemas/code-gen-tools.d.ts +0 -44
  16. package/build/schemas/code-gen-tools.js +0 -46
  17. package/build/schemas/doc-util-tools.d.ts +0 -54
  18. package/build/schemas/doc-util-tools.js +0 -58
  19. package/build/schemas/index.d.ts +0 -188
  20. package/build/schemas/orchestration-tools.d.ts +0 -22
  21. package/build/schemas/orchestration-tools.js +0 -23
  22. package/build/schemas/output/core-tools.d.ts +817 -0
  23. package/build/schemas/output/core-tools.js +421 -0
  24. package/build/schemas/output/generation-tools.d.ts +936 -0
  25. package/build/schemas/output/generation-tools.js +446 -0
  26. package/build/schemas/output/helper-tools.d.ts +243 -0
  27. package/build/schemas/output/helper-tools.js +138 -0
  28. package/build/schemas/output/index.d.ts +76 -0
  29. package/build/schemas/output/index.js +96 -0
  30. package/build/schemas/output/project-tools.d.ts +702 -0
  31. package/build/schemas/output/project-tools.js +339 -0
  32. package/build/schemas/output/ui-ux-tools.d.ts +469 -0
  33. package/build/schemas/output/ui-ux-tools.js +218 -0
  34. package/build/schemas/output/workflow-tools.d.ts +267 -0
  35. package/build/schemas/output/workflow-tools.js +179 -0
  36. package/build/schemas/structured-output.d.ts +1317 -0
  37. package/build/schemas/structured-output.js +1017 -0
  38. package/build/tools/__tests__/start_ui.integration.test.js +5 -5
  39. package/build/tools/__tests__/start_ui.property.test.js +11 -11
  40. package/build/tools/add_feature.d.ts +1 -13
  41. package/build/tools/add_feature.js +48 -13
  42. package/build/tools/analyze_project.js +57 -18
  43. package/build/tools/check_deps.d.ts +1 -13
  44. package/build/tools/check_deps.js +24 -15
  45. package/build/tools/code_review.d.ts +1 -13
  46. package/build/tools/code_review.js +19 -16
  47. package/build/tools/css_order.js +55 -55
  48. package/build/tools/debug.d.ts +1 -13
  49. package/build/tools/debug.js +18 -16
  50. package/build/tools/estimate.d.ts +1 -19
  51. package/build/tools/estimate.js +36 -6
  52. package/build/tools/fix_bug.d.ts +1 -13
  53. package/build/tools/fix_bug.js +24 -6
  54. package/build/tools/gen_mock.d.ts +1 -19
  55. package/build/tools/gen_mock.js +42 -227
  56. package/build/tools/genapi.d.ts +1 -13
  57. package/build/tools/genapi.js +18 -15
  58. package/build/tools/genchangelog.d.ts +1 -13
  59. package/build/tools/genchangelog.js +36 -212
  60. package/build/tools/gencommit.d.ts +1 -7
  61. package/build/tools/gencommit.js +21 -13
  62. package/build/tools/gendoc.d.ts +1 -13
  63. package/build/tools/gendoc.js +18 -15
  64. package/build/tools/genpr.d.ts +1 -13
  65. package/build/tools/genpr.js +28 -157
  66. package/build/tools/genreadme.d.ts +1 -13
  67. package/build/tools/genreadme.js +22 -587
  68. package/build/tools/gensql.d.ts +1 -13
  69. package/build/tools/gensql.js +24 -283
  70. package/build/tools/gentest.d.ts +1 -13
  71. package/build/tools/gentest.js +49 -16
  72. package/build/tools/index.d.ts +0 -10
  73. package/build/tools/index.js +0 -10
  74. package/build/tools/init_component_catalog.d.ts +3 -20
  75. package/build/tools/init_component_catalog.js +141 -786
  76. package/build/tools/init_project.d.ts +7 -13
  77. package/build/tools/init_project.js +54 -16
  78. package/build/tools/init_project_context.d.ts +1 -13
  79. package/build/tools/init_project_context.js +41 -14
  80. package/build/tools/perf.d.ts +1 -13
  81. package/build/tools/perf.js +18 -15
  82. package/build/tools/refactor.d.ts +1 -13
  83. package/build/tools/refactor.js +54 -15
  84. package/build/tools/render_ui.d.ts +2 -19
  85. package/build/tools/render_ui.js +201 -347
  86. package/build/tools/resolve_conflict.d.ts +1 -13
  87. package/build/tools/resolve_conflict.js +18 -15
  88. package/build/tools/security_scan.d.ts +1 -13
  89. package/build/tools/security_scan.js +16 -5
  90. package/build/tools/start_api.d.ts +7 -13
  91. package/build/tools/start_api.js +69 -157
  92. package/build/tools/start_bugfix.d.ts +1 -7
  93. package/build/tools/start_bugfix.js +38 -2
  94. package/build/tools/start_doc.d.ts +7 -13
  95. package/build/tools/start_doc.js +76 -169
  96. package/build/tools/start_feature.d.ts +1 -7
  97. package/build/tools/start_feature.js +54 -2
  98. package/build/tools/start_onboard.d.ts +1 -7
  99. package/build/tools/start_onboard.js +40 -2
  100. package/build/tools/start_ralph.d.ts +1 -7
  101. package/build/tools/start_ralph.js +88 -2
  102. package/build/tools/start_refactor.d.ts +7 -13
  103. package/build/tools/start_refactor.js +75 -148
  104. package/build/tools/start_release.d.ts +7 -13
  105. package/build/tools/start_release.js +56 -131
  106. package/build/tools/start_review.d.ts +7 -13
  107. package/build/tools/start_review.js +70 -142
  108. package/build/tools/start_ui.d.ts +1 -7
  109. package/build/tools/start_ui.js +98 -8
  110. package/build/tools/ui-ux-tools.d.ts +3 -39
  111. package/build/tools/ui-ux-tools.js +201 -125
  112. package/docs/data/tools.js +864 -0
  113. package/docs/index.html +594 -0
  114. package/docs/pages/all-tools.html +649 -0
  115. package/docs/pages/examples.html +564 -0
  116. package/docs/pages/getting-started.html +529 -0
  117. package/docs/pages/migration.html +308 -0
  118. package/docs/specs/algorithm-enhancement/roadmap.md +619 -0
  119. package/docs/specs/vnext-upgrade/00-OVERVIEW.md +258 -0
  120. package/docs/specs/vnext-upgrade/BETA_RELEASE_GUIDE.md +328 -0
  121. package/docs/specs/vnext-upgrade/GITHUB_DISCUSSION_TEMPLATE.md +236 -0
  122. package/docs/specs/vnext-upgrade/M8.9-PROGRESS-UPDATE.md +248 -0
  123. package/docs/specs/vnext-upgrade/PROGRESS-SUMMARY.md +195 -0
  124. package/docs/specs/vnext-upgrade/QUICK_REFERENCE.md +338 -0
  125. package/docs/specs/vnext-upgrade/README.md +125 -0
  126. package/docs/specs/vnext-upgrade/STATUS-UPDATE-2026-01-26.md +230 -0
  127. package/docs/specs/vnext-upgrade/TOOL_CLEANUP.md +343 -0
  128. package/docs/specs/vnext-upgrade/completed/M1-M2-SUMMARY.md +27 -0
  129. package/docs/specs/vnext-upgrade/completed/M3_COMPLETION_SUMMARY.md +273 -0
  130. package/docs/specs/vnext-upgrade/completed/M4-SUMMARY.md +19 -0
  131. package/docs/specs/vnext-upgrade/completed/M5_COMPLETION_SUMMARY.md +0 -0
  132. package/docs/specs/vnext-upgrade/completed/M8.1-SUMMARY.md +247 -0
  133. package/docs/specs/vnext-upgrade/completed/M8.2-SUMMARY.md +296 -0
  134. package/docs/specs/vnext-upgrade/completed/M8.3-SUMMARY.md +241 -0
  135. package/docs/specs/vnext-upgrade/completed/M8.3-TEST-SUMMARY.md +216 -0
  136. package/docs/specs/vnext-upgrade/completed/M8.4-SUMMARY.md +217 -0
  137. package/docs/specs/vnext-upgrade/completed/M8.4-TEST-SUMMARY.md +198 -0
  138. package/docs/specs/vnext-upgrade/completed/M8.5-SUMMARY.md +202 -0
  139. package/docs/specs/vnext-upgrade/completed/M8.5-TEST-SUMMARY.md +223 -0
  140. package/docs/specs/vnext-upgrade/completed/M8.6-SUMMARY.md +299 -0
  141. package/docs/specs/vnext-upgrade/completed/M8.8-TEST-SUMMARY.md +216 -0
  142. package/docs/specs/vnext-upgrade/completed/TOOL-CLEANUP-SUMMARY.md +210 -0
  143. package/docs/specs/vnext-upgrade/design.md +848 -0
  144. package/docs/specs/vnext-upgrade/requirements.md +221 -0
  145. package/docs/specs/vnext-upgrade/tasks/00-INDEX.md +335 -0
  146. package/docs/specs/vnext-upgrade/tasks/M8.1-SCHEMA-DEFINITION.md +300 -0
  147. package/docs/specs/vnext-upgrade/tasks/M8.2-P1-TOOLS.md +249 -0
  148. package/docs/specs/vnext-upgrade/tasks/M8.3-GENERATION-TOOLS.md +49 -0
  149. package/docs/specs/vnext-upgrade/tasks/M8.4-ORCHESTRATION-TOOLS.md +28 -0
  150. package/docs/specs/vnext-upgrade/tasks/M8.5-PROJECT-TOOLS.md +29 -0
  151. package/docs/specs/vnext-upgrade/tasks/M8.6-UI-TOOLS.md +66 -0
  152. package/docs/specs/vnext-upgrade/tasks/M8.7-HELPER-TOOLS.md +24 -0
  153. package/docs/specs/vnext-upgrade/tasks/M8.8-INTEGRATION-TESTS.md +90 -0
  154. package/docs/specs/vnext-upgrade/tasks/M8.9-DOCUMENTATION.md +103 -0
  155. package/docs/styles/docs.css +556 -0
  156. package/docs/styles/page.css +815 -0
  157. package/docs/vnext/MCP_2025-11-25_GUIDE.md +276 -0
  158. package/docs/vnext/vNext-PRD.md +488 -0
  159. package/package.json +4 -4
  160. package/build/utils/design-docs-generator.d.ts +0 -1
  161. package/build/utils/design-docs-generator.js +0 -1
  162. package/docs/BEST_PRACTICES.md +0 -1185
  163. package/docs/HOW_TO_TRIGGER.md +0 -1141
  164. package/docs/MCP-Probe-Kit-/344/275/277/347/224/250/346/211/213/345/206/214.html +0 -544
  165. package/docs/MCP-Probe-Kit-/344/275/277/347/224/250/346/211/213/345/206/214.md +0 -1447
@@ -1,1185 +0,0 @@
1
- # 📚 MCP Probe Kit 最佳实践
2
-
3
- > 完整的工具调用指南和使用技巧
4
-
5
- **版本**: v1.14.0 | **工具总数**: 46 个
6
-
7
- ---
8
-
9
- ## 📖 目录
10
-
11
- - [工具调用写法指南](#工具调用写法指南)
12
- - [UI/UX 工具调用](#uiux-工具调用) 🆕
13
- - [访谈工具调用](#访谈工具调用)
14
- - [基础工具调用](#基础工具调用)
15
- - [智能编排调用](#智能编排调用)
16
- - [使用技巧](#使用技巧)
17
- - [进阶技巧](#进阶技巧)
18
- - [注意事项](#注意事项)
19
-
20
- ---
21
-
22
- ## 🎯 工具调用写法指南
23
-
24
- ### UI/UX 工具调用 🆕
25
-
26
- #### ui_design_system - 设计系统生成
27
-
28
- ```
29
- # 方式 1:最简单(只指定技术栈)
30
- ui_design_system --stack react
31
-
32
- # 方式 2:指定主色调
33
- ui_design_system --stack react --primary-color "#3b82f6"
34
-
35
- # 方式 3:完整配置
36
- ui_design_system \
37
- --stack nextjs \
38
- --color-scheme light \
39
- --primary-color "#3b82f6" \
40
- --typography modern \
41
- --spacing normal \
42
- --border-radius medium
43
-
44
- # 方式 4:对话式
45
- "帮我生成一个 React 设计系统,主色调用蓝色"
46
- "为我的 Tailwind 项目生成配置"
47
-
48
- # 自动完成:
49
- # ✓ 生成完整的色彩系统(11 级色阶)
50
- # ✓ 生成字体系统(Sans/Serif/Mono)
51
- # ✓ 生成间距系统(基于 4px)
52
- # ✓ 生成组件样式(圆角、阴影、动画)
53
- # ✓ 输出可直接使用的代码
54
- ```
55
-
56
- #### ui_search - UI/UX 智能搜索
57
-
58
- ```
59
- # 方式 1:简单搜索
60
- ui_search "button primary"
61
-
62
- # 方式 2:指定类别
63
- ui_search "button" --category react
64
-
65
- # 方式 3:完整配置
66
- ui_search \
67
- --query "button primary hover" \
68
- --category react \
69
- --limit 5 \
70
- --min-score 1.0
71
-
72
- # 方式 4:对话式
73
- "我需要一个 React 的主按钮组件"
74
- "搜索一下蓝色主题的配色方案"
75
- "表单验证有什么 UX 最佳实践?"
76
-
77
- # 搜索技巧:
78
- # ✓ 使用具体关键词:"primary button hover" 而不是 "button"
79
- # ✓ 指定类别:colors, icons, react, vue, ux-guidelines 等
80
- # ✓ 调整结果数量:--limit 3(快速预览)或 --limit 20(详细搜索)
81
- # ✓ 支持中英文:可以搜索 "按钮" 或 "button"
82
- ```
83
-
84
- #### sync_ui_data - 数据同步
85
-
86
- ```
87
- # 方式 1:检查更新
88
- sync_ui_data
89
-
90
- # 方式 2:强制同步
91
- sync_ui_data --force
92
-
93
- # 方式 3:详细日志
94
- sync_ui_data --force --verbose
95
-
96
- # 方式 4:对话式
97
- "检查一下 UI 数据有没有更新"
98
- "强制更新 UI 数据"
99
-
100
- # 数据位置:
101
- # ✓ 内嵌数据:npm 包内部(离线可用)
102
- # ✓ 缓存数据:~/.mcp-probe-kit/ui-ux-data/(自动更新)
103
- ```
104
-
105
- ---
106
-
107
- ### 访谈工具调用
108
-
109
- #### interview - 需求访谈
110
-
111
- ```
112
- # 方式 1:直接调用
113
- interview "用户登录认证功能"
114
-
115
- # 方式 2:对话式
116
- interview
117
- 然后 AI 会询问功能描述
118
-
119
- # 自动完成:
120
- # ✓ 生成 12-15 个结构化问题(4个阶段)
121
- # ✓ 保存访谈记录到 docs/interviews/
122
- # ✓ 可选:立即开发或稍后使用
123
- ```
124
-
125
- #### ask_user - AI 主动提问
126
-
127
- ```
128
- # AI 自动调用(遇到不确定因素时)
129
- ask_user "优化目标是性能还是可读性?"
130
-
131
- # 用户主动触发
132
- "有什么需要我确认的吗?"
133
- "问我几个问题吧"
134
-
135
- # 带选项的提问
136
- ask_user --options ["方案A: 性能优先", "方案B: 可读性优先"]
137
- ```
138
-
139
- ---
140
-
141
- ### 基础工具调用
142
-
143
- #### 代码质量工具
144
-
145
- ```
146
- # 套壳检测
147
- detect_shell
148
-
149
- # 代码审查(审查当前文件)
150
- code_review
151
-
152
- # 代码审查(审查指定文件)
153
- code_review @src/utils/helper.ts
154
-
155
- # 安全扫描
156
- security_scan @api/user.ts
157
-
158
- # 调试助手(然后粘贴错误信息)
159
- debug
160
-
161
- # 生成测试
162
- gentest @src/components/Button.tsx
163
-
164
- # 重构建议
165
- refactor @legacy-code.js
166
-
167
- # 性能分析
168
- perf @slow-function.ts
169
-
170
- # 自动修复
171
- fix @file-with-errors.ts
172
- ```
173
-
174
- #### 开发效率工具
175
-
176
- ```
177
- # 生成 commit 消息
178
- gencommit
179
-
180
- # 生成 API 文档
181
- genapi @api/user.ts
182
-
183
- # 生成代码注释
184
- gendoc @utils/format.ts
185
-
186
- # 生成 PR 描述
187
- genpr
188
-
189
- # 生成 Changelog
190
- genchangelog v1.2.0
191
-
192
- # 生成 SQL
193
- gensql
194
- 然后描述需求:"查询最近30天注册的活跃用户"
195
-
196
- # 生成 UI 组件
197
- genui
198
- 然后描述:"创建一个带加载状态的 Button 组件"
199
-
200
- # 生成 Mock 数据
201
- gen_mock
202
- 然后提供数据结构:
203
- interface User {
204
- id: string;
205
- name: string;
206
- email: string;
207
- }
208
-
209
- # 设计稿转代码
210
- design2code
211
- 然后提供设计稿图片URL、描述或HTML代码
212
-
213
- # 代码解释
214
- explain @complex-algorithm.ts
215
-
216
- # 代码转换
217
- convert @old-code.js
218
- 然后说明:"转为 TypeScript"
219
-
220
- # CSS 属性排序
221
- css_order
222
-
223
- # 生成 README
224
- genreadme
225
-
226
- # 文件拆分
227
- split @LargeComponent.tsx
228
-
229
- # Bug 修复流程
230
- fix_bug
231
- 然后提供错误信息和堆栈
232
-
233
- # 工作量估算
234
- estimate
235
- 然后描述任务:"实现用户登录功能"
236
-
237
- # 生成 Agent Skills 文档
238
- gen_skill
239
-
240
- # 生成单个工具的技能文档
241
- gen_skill --tool_name code_review
242
-
243
- # 生成分析类工具的技能文档
244
- gen_skill --scope analysis
245
- ```
246
-
247
- #### 项目管理工具
248
-
249
- ```
250
- # 初始化 AI 配置
251
- init_setting
252
-
253
- # 初始化项目(Spec-Driven)
254
- init_project
255
- 然后提供需求描述或 @requirements.md
256
-
257
- # 检查依赖健康度
258
- check_deps
259
-
260
- # 解决 Git 冲突
261
- resolve_conflict
262
- 然后粘贴冲突内容或打开冲突文件
263
-
264
- # 分析项目结构
265
- analyze_project
266
-
267
- # 生成项目上下文
268
- init_project_context
269
-
270
- # 添加新功能
271
- add_feature user-auth "用户登录认证功能"
272
- ```
273
-
274
- ---
275
-
276
- ### 智能编排调用
277
-
278
- #### start_feature - 新功能开发(推荐)
279
-
280
- ```
281
- # 方式 1:直接调用
282
- start_feature user-profile "用户个人资料管理"
283
-
284
- # 方式 2:对话式
285
- start_feature
286
- 然后 AI 会询问功能名称和描述
287
-
288
- # 自动完成:
289
- # ✓ 检查/生成项目上下文
290
- # ✓ 生成功能规格(需求/设计/任务)
291
- # ✓ 工作量估算
292
- ```
293
-
294
- #### start_bugfix - Bug 修复(推荐)
295
-
296
- ```
297
- # 方式 1:提供错误信息
298
- start_bugfix
299
- 然后粘贴错误信息和堆栈
300
-
301
- # 方式 2:简洁调用
302
- 遇到 Bug 时直接说:"start_bugfix 帮我修复这个错误"
303
-
304
- # 自动完成:
305
- # ✓ 检查/生成项目上下文
306
- # ✓ 问题定位和原因分析
307
- # ✓ 生成修复方案
308
- # ✓ 生成回归测试
309
- # ✓ 生成 commit 消息
310
- ```
311
-
312
- #### start_review - 代码体检(推荐)
313
-
314
- ```
315
- # 审查当前文件
316
- start_review
317
-
318
- # 审查指定文件
319
- start_review @src/api/payment.ts
320
-
321
- # 自动完成:
322
- # ✓ 检查/生成项目上下文
323
- # ✓ 代码质量审查
324
- # ✓ 安全漏洞扫描
325
- # ✓ 性能分析
326
- # ✓ 生成综合报告
327
- ```
328
-
329
- #### start_release - 发布准备(推荐)
330
-
331
- ```
332
- # 准备发布 v1.2.0
333
- start_release v1.2.0
334
-
335
- # 指定起始版本
336
- start_release v1.2.0 --from v1.1.0
337
-
338
- # 自动完成:
339
- # ✓ 检查/生成项目上下文
340
- # ✓ 生成 Changelog
341
- # ✓ 生成 PR 描述
342
- # ✓ 提供发布检查清单
343
- ```
344
-
345
- #### start_refactor - 代码重构(推荐)
346
-
347
- ```
348
- # 重构当前文件
349
- start_refactor
350
-
351
- # 重构指定文件
352
- start_refactor @legacy/old-module.js
353
-
354
- # 指定重构目标
355
- start_refactor @code.ts --goal reduce_complexity
356
-
357
- # 自动完成:
358
- # ✓ 检查/生成项目上下文
359
- # ✓ 代码审查发现问题
360
- # ✓ 生成重构方案
361
- # ✓ 生成保护测试
362
- ```
363
-
364
- #### start_onboard - 快速上手项目(推荐)
365
-
366
- ```
367
- # 分析当前项目
368
- start_onboard
369
-
370
- # 分析指定项目
371
- start_onboard /path/to/project
372
-
373
- # 自动完成:
374
- # ✓ 深度分析项目结构
375
- # ✓ 生成项目上下文文档
376
- # ✓ 提供项目概览和快速开始指南
377
- ```
378
-
379
- #### start_api - API 开发(推荐)
380
-
381
- ```
382
- # 为 API 生成完整资料
383
- start_api @api/user.ts
384
-
385
- # 自动完成:
386
- # ✓ 检查/生成项目上下文
387
- # ✓ 生成 API 文档
388
- # ✓ 生成 Mock 数据
389
- # ✓ 生成 API 测试
390
- ```
391
-
392
- #### start_doc - 文档生成(推荐)
393
-
394
- ```
395
- # 为项目生成完整文档
396
- start_doc
397
-
398
- # 为指定代码生成文档
399
- start_doc @src/
400
-
401
- # 自动完成:
402
- # ✓ 检查/生成项目上下文
403
- # ✓ 生成代码注释
404
- # ✓ 生成 README
405
- # ✓ 生成 API 文档
406
- ```
407
-
408
- #### start_ralph - Ralph Loop 循环开发(推荐)🆕
409
-
410
- ```
411
- # 启动循环开发
412
- start_ralph "实现用户登录功能"
413
-
414
- # 指定模式和参数
415
- start_ralph --goal "修复登录 bug" --mode safe --max_iterations 10
416
-
417
- # 自动完成:
418
- # ✓ 生成 .ralph/ 目录结构
419
- # ✓ 生成 PROMPT.md(循环 prompt)
420
- # ✓ 生成 @fix_plan.md(任务清单)
421
- # ✓ 生成 PROGRESS.md(迭代日志)
422
- # ✓ 生成安全模式脚本(多重保护)
423
- # ✓ 提供执行指南
424
-
425
- # 然后:
426
- cd .ralph
427
- chmod +x ralph_loop_safe.sh # Linux/Mac
428
- ./ralph_loop_safe.sh
429
-
430
- # Windows:
431
- # powershell -ExecutionPolicy Bypass -File ralph_loop_safe.ps1
432
- ```
433
-
434
- ---
435
-
436
- ## 💡 使用技巧
437
-
438
- ### 0. Interview 模式最佳实践 🆕
439
-
440
- #### 何时使用 Interview 模式
441
-
442
- **✅ 推荐使用:**
443
- ```
444
- - 需求描述简短、不明确
445
- - 复杂的业务功能
446
- - 涉及多方协作的功能
447
- - 有较多技术约束的功能
448
- - 第一次做某类功能
449
- ```
450
-
451
- **❌ 不推荐使用:**
452
- ```
453
- - 简单的 Bug 修复
454
- - 需求非常明确的功能
455
- - 紧急的小改动
456
- - 重复性的简单任务
457
- ```
458
-
459
- #### Interview 工作流程
460
-
461
- **流程 1:立即开发**
462
- ```
463
- 1. interview "用户登录功能"
464
- # 生成 12-15 个问题
465
-
466
- 2. 回答所有问题
467
- # AI 生成访谈记录
468
-
469
- 3. start_feature --from-interview user-login
470
- # 基于访谈生成规格文档
471
-
472
- 4. 根据 tasks.md 开始编码
473
- ```
474
-
475
- **流程 2:分步进行**
476
- ```
477
- 第1天:
478
- 1. interview "用户登录功能"
479
- 2. 回答问题
480
- 3. AI 保存访谈记录
481
-
482
- 第3天:
483
- 1. "开始做登录功能"
484
- 2. start_feature --from-interview user-login
485
- 3. AI 读取之前的访谈,生成规格
486
- ```
487
-
488
- **流程 3:仅生成规格**
489
- ```
490
- 1. interview "用户登录功能"
491
- 2. 回答问题
492
- 3. add_feature --from-interview user-login
493
- # 只生成规格文档,不估算工作量
494
- ```
495
-
496
- #### ask_user 使用场景
497
-
498
- ```
499
- 场景1: 技术方案选择
500
- AI: "可以用两种方案实现"
501
- 调用: ask_user --options ["方案A: 性能优先", "方案B: 可读性优先"]
502
-
503
- 场景2: 代码审查时
504
- AI: "发现了性能问题,但不确定优先级"
505
- 调用: ask_user "这个性能问题的优先级如何?"
506
-
507
- 场景3: Bug 修复时
508
- AI: "需要确认是否向后兼容"
509
- 调用: ask_user "修复这个 Bug 是否需要保持向后兼容?"
510
-
511
- 场景4: 功能开发时
512
- AI: "支付方式有多种选择"
513
- 调用: ask_user "你希望支持哪些支付方式?"
514
- ```
515
-
516
- ---
517
-
518
- ### 1. 优先使用智能编排
519
-
520
- **❌ 不推荐(手动调用多个工具)**
521
- ```
522
- 1. init_project_context
523
- 2. add_feature user-auth "用户登录"
524
- 3. estimate "实现用户登录功能"
525
- ```
526
-
527
- **✅ 推荐(使用智能编排)**
528
- ```
529
- start_feature user-auth "用户登录认证功能"
530
- # 一键完成所有步骤
531
- ```
532
-
533
- ---
534
-
535
- ### 2. 善用文件引用
536
-
537
- **引用单个文件**
538
- ```
539
- code_review @src/utils/helper.ts
540
- ```
541
-
542
- **引用多个文件**
543
- ```
544
- code_review @src/utils/helper.ts @src/utils/format.ts
545
- ```
546
-
547
- **引用整个目录**
548
- ```
549
- start_doc @src/components/
550
- ```
551
-
552
- ---
553
-
554
- ### 3. 对话式调用
555
-
556
- 大多数工具支持对话式调用,AI 会引导你提供必要信息:
557
-
558
- ```
559
- # 直接调用工具名
560
- gen_mock
561
-
562
- # AI 会询问:
563
- # "请提供数据结构定义(TypeScript interface 或 JSON Schema)"
564
-
565
- # 你提供:
566
- interface User {
567
- id: string;
568
- name: string;
569
- email: string;
570
- }
571
-
572
- # AI 会继续询问其他可选参数
573
- ```
574
-
575
- ---
576
-
577
- ### 4. 组合使用工具
578
-
579
- #### 场景:Interview 模式开发新功能 🆕
580
-
581
- ```
582
- 1. interview "用户个人资料"
583
- # 访谈澄清需求
584
-
585
- 2. 回答 12-15 个问题
586
-
587
- 3. start_feature --from-interview user-profile
588
- # 生成规格文档和估算
589
-
590
- 4. 根据 tasks.md 开始编码...
591
-
592
- 5. start_review @src/profile/
593
- # 代码体检
594
-
595
- 6. gentest @src/profile/ProfileCard.tsx
596
- # 补充测试
597
-
598
- 7. gencommit
599
- # 提交代码
600
- ```
601
-
602
- #### 场景:传统方式开发新功能
603
-
604
- ```
605
- 1. start_feature user-profile "用户个人资料"
606
- # 生成规格文档和估算
607
-
608
- 2. 根据 tasks.md 开始编码...
609
-
610
- 3. start_review @src/profile/
611
- # 代码体检
612
-
613
- 4. gentest @src/profile/ProfileCard.tsx
614
- # 补充测试
615
-
616
- 5. gencommit
617
- # 提交代码
618
- ```
619
-
620
- #### 场景:修复 Bug 的完整流程
621
-
622
- ```
623
- 1. start_bugfix
624
- # 粘贴错误信息,自动完成分析、修复、测试
625
-
626
- 2. 验证修复...
627
-
628
- 3. gencommit
629
- # 已在 start_bugfix 中生成,直接使用
630
- ```
631
-
632
- #### 场景:代码重构
633
-
634
- ```
635
- 1. start_review @old-code.ts
636
- # 先体检,发现问题
637
-
638
- 2. start_refactor @old-code.ts
639
- # 重构并生成测试
640
-
641
- 3. gencommit
642
- # 提交重构
643
- ```
644
-
645
- ---
646
-
647
- ### 5. 项目初始化最佳实践
648
-
649
- #### 新项目
650
-
651
- ```
652
- 1. init_project
653
- # 提供需求,生成项目结构
654
-
655
- 2. init_setting
656
- # 配置 AI
657
-
658
- 3. init_project_context
659
- # 生成项目上下文
660
-
661
- 4. 开始开发...
662
- ```
663
-
664
- #### 接手老项目
665
-
666
- ```
667
- 1. start_onboard
668
- # 快速了解项目(包含 analyze_project + init_project_context)
669
-
670
- 2. check_deps
671
- # 检查依赖健康度
672
-
673
- 3. start_review @src/
674
- # 代码质量评估
675
-
676
- 4. 开始维护...
677
- ```
678
-
679
- ---
680
-
681
- ### 6. 安全开发最佳实践
682
-
683
- #### 开发阶段
684
-
685
- ```
686
- 1. 编写代码...
687
-
688
- 2. security_scan @new-feature.ts
689
- # 安全扫描
690
-
691
- 3. start_review @new-feature.ts
692
- # 全面体检(包含安全扫描)
693
- ```
694
-
695
- #### 发布前
696
-
697
- ```
698
- 1. start_review @src/
699
- # 全面代码体检
700
-
701
- 2. check_deps
702
- # 检查依赖漏洞
703
-
704
- 3. start_release v1.2.0
705
- # 准备发布
706
- ```
707
-
708
- ---
709
-
710
- ### 7. 文档维护最佳实践
711
-
712
- #### 代码文档
713
-
714
- ```
715
- 1. gendoc @src/utils/
716
- # 生成代码注释
717
-
718
- 2. genapi @api/
719
- # 生成 API 文档
720
-
721
- 3. start_doc @src/
722
- # 生成完整文档(包含上述两步)
723
- ```
724
-
725
- #### 项目文档
726
-
727
- ```
728
- 1. genreadme
729
- # 生成/更新 README
730
-
731
- 2. genchangelog v1.2.0
732
- # 更新 Changelog
733
-
734
- 3. init_project_context
735
- # 更新项目上下文
736
- ```
737
-
738
- ---
739
-
740
- ### 8. 性能优化流程
741
-
742
- ```
743
- 1. perf @slow-function.ts
744
- # 性能分析
745
-
746
- 2. start_refactor @slow-function.ts --goal improve_performance
747
- # 重构优化
748
-
749
- 3. gentest @optimized-function.ts
750
- # 性能测试
751
-
752
- 4. 对比优化前后性能...
753
-
754
- 5. gencommit
755
- # 提交优化
756
- ```
757
-
758
- ---
759
-
760
- ## 🎓 进阶技巧
761
-
762
- ### 批量操作
763
-
764
- ```
765
- # 批量审查多个文件
766
- code_review @src/api/*.ts
767
-
768
- # 批量生成测试
769
- gentest @src/components/*.tsx
770
-
771
- # 批量生成文档
772
- start_doc @src/
773
- ```
774
-
775
- ### 自定义参数
776
-
777
- ```
778
- # 指定测试框架
779
- gentest @component.tsx --framework vitest
780
-
781
- # 指定文档格式
782
- genapi @api.ts --format openapi
783
-
784
- # 指定 Mock 数据数量
785
- gen_mock --count 10
786
-
787
- # 指定重构目标
788
- start_refactor @code.ts --goal reduce_complexity
789
- ```
790
-
791
- ### 链式调用
792
-
793
- ```
794
- # 一次对话完成多个操作
795
- "帮我审查 @user.ts,然后生成测试,最后生成 commit 消息"
796
-
797
- # AI 会依次调用:
798
- # 1. code_review @user.ts
799
- # 2. gentest @user.ts
800
- # 3. gencommit
801
- ```
802
-
803
- ---
804
-
805
- ## ⚠️ 注意事项
806
-
807
- ### 1. 智能编排会自动处理项目上下文
808
-
809
- - 无需手动调用 `init_project_context`
810
- - 首次使用会自动生成
811
- - 后续调用会自动读取
812
-
813
- ### 2. 文件引用使用 @ 符号
814
-
815
- - `@file.ts` - 引用文件
816
- - `@folder/` - 引用目录
817
- - `@*.ts` - 通配符匹配
818
-
819
- ### 3. 大型项目建议分批处理
820
-
821
- - 不要一次审查整个项目
822
- - 按模块或功能分批进行
823
- - 避免超时或响应过长
824
-
825
- ### 4. 定期更新项目上下文
826
-
827
- - 技术栈变更后重新运行 `init_project_context`
828
- - 保持上下文文档最新
829
- - 有助于 AI 生成更准确的代码
830
-
831
- ### 5. 善用编排工具
832
-
833
- - 优先使用 `start_*` 编排工具
834
- - 减少手动调用多个工具的次数
835
- - 提高开发效率
836
-
837
- ---
838
-
839
- ## 📊 工具选择决策树
840
-
841
- ```
842
- 需要做什么?
843
-
844
- ├─ 需求不明确?
845
- │ └─ interview ✅ → 访谈澄清 → start_feature
846
-
847
- ├─ 开发新功能(需求明确)
848
- │ └─ start_feature ✅
849
-
850
- ├─ 修复 Bug
851
- │ └─ start_bugfix ✅
852
-
853
- ├─ 代码审查
854
- │ ├─ 只看质量 → code_review
855
- │ ├─ 只看安全 → security_scan
856
- │ ├─ 只看性能 → perf
857
- │ └─ 全面体检 → start_review ✅
858
-
859
- ├─ 重构代码
860
- │ └─ start_refactor ✅
861
-
862
- ├─ 接手项目
863
- │ └─ start_onboard ✅
864
-
865
- ├─ 开发 API
866
- │ └─ start_api ✅
867
-
868
- ├─ 生成文档
869
- │ ├─ 只要 README → genreadme
870
- │ ├─ 只要 API 文档 → genapi
871
- │ └─ 完整文档 → start_doc ✅
872
-
873
- ├─ 准备发布
874
- │ └─ start_release ✅
875
-
876
- └─ 其他单一任务
877
- └─ 使用对应的基础工具
878
- ```
879
-
880
- ---
881
-
882
- ## 🚀 快速参考
883
-
884
- ### 最常用的 10 个命令
885
-
886
- | 命令 | 用途 | 频率 |
887
- |------|------|------|
888
- | `interview` | 需求访谈 | ⭐⭐⭐⭐⭐ 🆕 |
889
- | `start_feature` | 开发新功能 | ⭐⭐⭐⭐⭐ |
890
- | `start_bugfix` | 修复 Bug | ⭐⭐⭐⭐⭐ |
891
- | `start_ralph` | 循环开发 | ⭐⭐⭐⭐ 🆕 |
892
- | `start_review` | 代码体检 | ⭐⭐⭐⭐ |
893
- | `gencommit` | 生成提交 | ⭐⭐⭐⭐ |
894
- | `gentest` | 生成测试 | ⭐⭐⭐⭐ |
895
- | `ask_user` | AI 提问 | ⭐⭐⭐ 🆕 |
896
- | `start_onboard` | 快速上手 | ⭐⭐⭐ |
897
- | `start_refactor` | 代码重构 | ⭐⭐⭐ |
898
-
899
- ---
900
-
901
- ## 💬 实际对话示例
902
-
903
- ### 示例 1:Interview 模式开发新功能 🆕
904
-
905
- ```
906
- 你: interview "用户设置页面"
907
-
908
- AI: 好的,我来帮你访谈这个需求。
909
-
910
- [阶段 1: 背景理解]
911
- Q1: 这个功能要解决什么问题或痛点?
912
- Q2: 主要用户是谁?他们的使用场景是什么?
913
- Q3: 这个功能的业务驱动是什么?
914
-
915
- [阶段 2: 功能边界]
916
- Q4: 这个功能的核心价值是什么?
917
- Q5: 功能范围包括哪些?不包括哪些?
918
- ...
919
-
920
- 你: [回答所有问题]
921
-
922
- AI: 好的,访谈完成。
923
- ✓ 已生成 docs/interviews/user-settings-interview.md
924
-
925
- 下一步:
926
- - 立即开发: start_feature --from-interview user-settings
927
- - 生成规格: add_feature --from-interview user-settings
928
- - 稍后开发: 访谈记录已保存,随时可用
929
- ```
930
-
931
- ### 示例 2:开发新功能(需求明确)
932
-
933
- ```
934
- 你: start_feature user-settings "用户设置页面"
935
-
936
- AI: 好的,我来帮你开发用户设置功能。
937
-
938
- [检查项目上下文...]
939
- ✓ 已读取项目上下文
940
-
941
- [生成功能规格...]
942
- ✓ 已生成 docs/specs/user-settings/requirements.md
943
- ✓ 已生成 docs/specs/user-settings/design.md
944
- ✓ 已生成 docs/specs/user-settings/tasks.md
945
-
946
- [工作量估算...]
947
- ✓ 预估:5 故事点 / 1-2 天
948
- ✓ 主要风险:需要集成第三方服务
949
-
950
- 下一步:请按照 tasks.md 中的任务清单开始开发。
951
- ```
952
-
953
- ### 示例 2:修复 Bug
954
-
955
- ```
956
- 你: start_bugfix
957
-
958
- AI: 请提供错误信息和堆栈跟踪。
959
-
960
- 你: [粘贴错误信息]
961
- TypeError: Cannot read property 'name' of undefined
962
- at UserProfile.render (UserProfile.tsx:45)
963
-
964
- AI: 好的,我来帮你修复这个 Bug。
965
-
966
- [问题定位...]
967
- ✓ 问题文件:UserProfile.tsx:45
968
- ✓ 原因:user 对象可能为 null
969
-
970
- [生成修复方案...]
971
- ✓ 修复方案:添加空值检查
972
-
973
- [生成测试...]
974
- ✓ 已生成回归测试
975
-
976
- [生成 commit...]
977
- ✓ Commit 消息:fix: 🐛 修复用户资料页面空指针异常
978
-
979
- 修复完成!请验证后提交。
980
- ```
981
-
982
- ### 示例 3:代码体检
983
-
984
- ```
985
- 你: start_review @src/api/payment.ts
986
-
987
- AI: 好的,我来对支付 API 进行全面体检。
988
-
989
- [代码质量审查...]
990
- ✓ 发现 3 个问题
991
-
992
- [安全扫描...]
993
- ⚠️ 发现 1 个高危漏洞:硬编码 API 密钥
994
-
995
- [性能分析...]
996
- ✓ 性能良好
997
-
998
- 综合评分:6/10
999
-
1000
- 建议优先修复:
1001
- 1. [高危] 移除硬编码的 API 密钥
1002
- 2. [中] 添加错误处理
1003
- 3. [低] 改进命名规范
1004
- ```
1005
-
1006
- ---
1007
-
1008
- ## 🎨 UI/UX 工具使用技巧 🆕
1009
-
1010
- ### 设计系统生成技巧
1011
-
1012
- **1. 新项目启动**
1013
- ```
1014
- # 步骤 1:生成基础设计系统
1015
- ui_design_system --stack react
1016
-
1017
- # 步骤 2:根据需求调整
1018
- ui_design_system --stack react --primary-color "#3b82f6" --border-radius large
1019
-
1020
- # 步骤 3:复制生成的代码到项目中
1021
- ```
1022
-
1023
- **2. 技术栈选择**
1024
- ```
1025
- # React 项目
1026
- ui_design_system --stack react
1027
-
1028
- # Next.js 项目
1029
- ui_design_system --stack nextjs
1030
-
1031
- # Tailwind 项目(生成 tailwind.config.js)
1032
- ui_design_system --stack tailwind
1033
-
1034
- # Vue 项目
1035
- ui_design_system --stack vue
1036
- ```
1037
-
1038
- **3. 主题定制**
1039
- ```
1040
- # 浅色主题
1041
- ui_design_system --stack react --color-scheme light
1042
-
1043
- # 深色主题
1044
- ui_design_system --stack react --color-scheme dark
1045
-
1046
- # 自适应主题
1047
- ui_design_system --stack react --color-scheme auto
1048
- ```
1049
-
1050
- ### UI 搜索技巧
1051
-
1052
- **1. 组件搜索**
1053
- ```
1054
- # ❌ 不好:太模糊
1055
- ui_search "button"
1056
-
1057
- # ✅ 好:具体明确
1058
- ui_search "button primary hover effect" --category react
1059
-
1060
- # ✅ 更好:指定技术栈
1061
- ui_search "button primary" --category react --limit 5
1062
- ```
1063
-
1064
- **2. 颜色搜索**
1065
- ```
1066
- # 搜索配色方案
1067
- ui_search "blue professional" --category colors
1068
-
1069
- # 搜索特定用途的颜色
1070
- ui_search "saas tech primary color" --category colors
1071
-
1072
- # 搜索完整色阶
1073
- ui_search "blue gradient" --category colors
1074
- ```
1075
-
1076
- **3. 最佳实践搜索**
1077
- ```
1078
- # 搜索 UX 指南
1079
- ui_search "form validation" --category ux-guidelines
1080
-
1081
- # 搜索性能优化
1082
- ui_search "react performance" --category react-performance
1083
-
1084
- # 搜索设计模式
1085
- ui_search "card layout" --category web-interface
1086
- ```
1087
-
1088
- **4. 调整搜索结果**
1089
- ```
1090
- # 快速预览(3 个结果)
1091
- ui_search "button" --limit 3
1092
-
1093
- # 详细搜索(20 个结果)
1094
- ui_search "button" --limit 20
1095
-
1096
- # 过滤低相关性结果
1097
- ui_search "button" --min-score 2.0
1098
- ```
1099
-
1100
- ### 数据同步技巧
1101
-
1102
- **1. 定期检查**
1103
- ```
1104
- # 每周检查一次(推荐)
1105
- sync_ui_data
1106
-
1107
- # 如果已是最新版本,不会重复下载
1108
- ```
1109
-
1110
- **2. 遇到问题时**
1111
- ```
1112
- # 搜索结果不准确?强制更新
1113
- sync_ui_data --force --verbose
1114
-
1115
- # 查看详细日志
1116
- sync_ui_data --verbose
1117
- ```
1118
-
1119
- **3. 数据位置**
1120
- ```
1121
- # 内嵌数据(离线可用)
1122
- 位置:npm 包内部
1123
- 更新:重新安装 mcp-probe-kit
1124
-
1125
- # 缓存数据(自动更新)
1126
- 位置:~/.mcp-probe-kit/ui-ux-data/
1127
- 更新:首次使用时自动检查
1128
-
1129
- # 手动同步(立即更新)
1130
- 命令:sync_ui_data --force
1131
- ```
1132
-
1133
- ### 组合使用技巧
1134
-
1135
- **场景 1:新项目完整流程**
1136
- ```
1137
- # 步骤 1:生成设计系统
1138
- ui_design_system --stack react --primary-color "#3b82f6"
1139
-
1140
- # 步骤 2:搜索需要的组件
1141
- ui_search "button card form" --category react
1142
-
1143
- # 步骤 3:搜索配色方案
1144
- ui_search "blue professional" --category colors
1145
-
1146
- # 步骤 4:应用到项目
1147
- ```
1148
-
1149
- **场景 2:优化现有项目**
1150
- ```
1151
- # 步骤 1:搜索最佳实践
1152
- ui_search "form validation ux" --category ux-guidelines
1153
-
1154
- # 步骤 2:搜索优化方案
1155
- ui_search "react performance" --category react-performance
1156
-
1157
- # 步骤 3:搜索改进的组件
1158
- ui_search "button loading state" --category react
1159
- ```
1160
-
1161
- **场景 3:设计系统迁移**
1162
- ```
1163
- # 步骤 1:生成新的设计系统
1164
- ui_design_system --stack tailwind
1165
-
1166
- # 步骤 2:搜索对应的组件
1167
- ui_search "button" --category tailwind
1168
-
1169
- # 步骤 3:逐步替换旧组件
1170
- ```
1171
-
1172
- ---
1173
-
1174
- ## 📚 相关文档
1175
-
1176
- - [README](../README.md) - 项目介绍和快速开始
1177
- - [工具列表](../README.md#功能特性) - 所有工具的详细说明
1178
- - [UI/UX 快速开始](../QUICK-START-UI-UX.md) - UI/UX 工具快速入门 🆕
1179
- - [UI/UX 完整文档](./UI-UX-PRO-MAX-GUIDE.md) - UI/UX 工具详细文档 🆕
1180
- - [UI/UX 使用演示](./UI-UX-DEMO.md) - UI/UX 工具使用示例 🆕
1181
- - [常见问题](../README.md#常见问题) - FAQ
1182
-
1183
- ---
1184
-
1185
- **Made with ❤️ for AI-Powered Development**