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
package/README.md CHANGED
@@ -5,1573 +5,167 @@
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
6
  [![GitHub stars](https://img.shields.io/github/stars/mybolide/mcp-probe-kit.svg)](https://github.com/mybolide/mcp-probe-kit/stargazers)
7
7
 
8
- > 🚀 AI 开发增强工具集 - 让 AI 更懂你的开发流程
8
+ > 🚀 AI 驱动的完整研发工具集 - 覆盖开发全流程
9
9
 
10
- 一个强大的 MCP (Model Context Protocol) 服务器,提供 **49 个实用工具**(37 个基础工具 + 9 个智能编排 + 3 个 UI/UX 新增),覆盖代码质量、开发效率、项目管理、UI/UX 设计全流程。
10
+ 一个强大的 MCP (Model Context Protocol) 服务器,提供 **39 个实用工具**,覆盖代码质量、开发效率、项目管理、UI/UX 设计全流程,所有工具都支持**结构化输出**。
11
11
 
12
- **✨ v1.14.0 新增**: UI/UX Pro Max - 完整 UI 开发工作流,从设计系统到最终代码,支持 React、Vue、Tailwind 等多种技术栈!
12
+ **🎉 v2.0 特性**:结构化输出、工作流编排、UI/UX Pro Max、需求访谈
13
13
 
14
14
  **支持所有 MCP 客户端**:Cursor、Claude Desktop、Cline、Continue 等
15
15
 
16
- **作者**: [小墨 (Kyle)](https://www.bytezonex.com/) | **项目**: [GitHub](https://github.com/mybolide/mcp-probe-kit) | **npm**: [mcp-probe-kit](https://www.npmjs.com/package/mcp-probe-kit)
17
-
18
- ---
19
-
20
- ## ✨ 功能特性
21
-
22
- ### 🎨 UI/UX Pro Max(6 个工具)🆕
23
- - **`ui_design_system`** - 设计系统生成器:基于 100 条行业规则的智能推荐,生成设计推荐和创作指导,AI 根据指导自由创作文档(输出 ASCII Box + JSON + 创作指导)
24
- - **`init_component_catalog`** - 组件目录生成器:基于设计系统生成组件目录,定义可用的 UI 组件及其属性(占位符语法)
25
- - **`render_ui`** - UI 渲染引擎:将 JSON 模板渲染为最终代码,自动应用设计规范(占位符替换)
26
- - **`start_ui`** - 统一 UI 开发编排:一键完成整个 UI 开发流程(支持 `auto` 智能模式,自动推导设计参数)
27
- - **`ui_search`** - UI/UX 智能搜索:BM25 算法搜索颜色、图标、图表、组件、设计模式等 24 类数据(支持 catalog/template 模式)
28
- - **`sync_ui_data`** - 数据同步工具:从 npm 包 `uipro-cli` 自动同步最新 UI/UX 数据(来源:[ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill))
29
-
30
- **完整工作流**:
31
- ```bash
32
- # 🚀 方式一:智能模式(推荐)
33
- # 一句话描述需求,AI 自动推导设计风格、配色和技术栈
34
- start_ui "SaaS 后台管理系统" --mode=auto
35
-
36
- # 📦 方式二:手动模式
37
- # 1. 生成设计系统 (可省略 product_type,AI 会自动从描述推导)
38
- ui_design_system --stack="react" --description="企业级 CRM 客户管理系统"
39
-
40
- # 2. 生成页面(自动应用设计规范)
41
- start_ui "登录页面"
42
- start_ui "用户列表"
43
-
44
- # 结果:所有页面样式完全统一 ✨
45
- ```
46
-
47
- ### 🤖 智能模式 vs 手动模式
48
-
49
- `start_ui` 支持两种模式,满足不同场景需求:
50
-
51
- #### 1. 自动模式 (`--mode=auto`) - **推荐**
52
- AI 自动分析你的自然语言描述,推导最佳参数并生成执行计划。
53
- ```bash
54
- start_ui "加密货币交易看板" --mode=auto
55
- ```
56
- **特点**:
57
- - ✅ 自动推导产品类型 (Fintech)
58
- - ✅ 自动推导设计风格 (Dark Mode, High Contrast)
59
- - ✅ 自动推导技术栈
60
- - ✅ 直接生成可执行命令
61
-
62
- #### 2. 手动模式 (`--mode=manual`)
63
- 生成详细的分步指南,由你手动控制每一步的执行。
64
- ```bash
65
- start_ui "登录页面" --mode=manual
66
- ```
67
- **特点**:
68
- - ✅ 返回 4 个标准步骤的执行指南
69
- - ✅ 适合需要精细控制参数的场景
70
- - ✅ 适合学习和理解工作流
71
- - ✅ 默认模式(如果不指定 --mode)
72
-
73
- ### �🎯 访谈工具(2 个工具)
74
- - **`interview`** - 需求访谈模式:在开发前通过结构化提问澄清需求,避免理解偏差和返工
75
- - **`ask_user`** - 通用提问工具:AI 可随时向用户提问,澄清不确定的信息
76
-
77
- ### 🔍 代码质量(8 个工具)
78
- - **`detect_shell`** - AI 模型套壳检测
79
- - **`code_review`** - 代码审查助手
80
- - **`security_scan`** - 安全漏洞扫描
81
- - **`debug`** - 智能调试助手
82
- - **`gentest`** - 测试用例生成器
83
- - **`refactor`** - 重构建议
84
- - **`perf`** - 性能分析
85
- - **`fix`** - 自动修复代码问题
86
-
87
- ### 🛠️ 开发效率(16 个工具)
88
- - **`gencommit`** - Git 提交消息生成
89
- - **`genapi`** - API 文档生成
90
- - **`gendoc`** - 代码注释生成
91
- - **`genpr`** - PR 描述生成
92
- - **`genchangelog`** - Changelog 生成
93
- - **`gensql`** - SQL 查询生成器
94
- - **`genui`** - UI 组件生成器(React + Vue)
95
- - **`gen_mock`** - Mock 数据生成器
96
- - **`gen_skill`** - Agent Skills 文档生成器
97
- - **`design2code`** - 设计稿转代码(图片/描述/HTML → Vue/React)
98
- - **`explain`** - 代码解释器
99
- - **`convert`** - 代码转换器
100
- - **`css_order`** - CSS 属性顺序规范
101
- - **`genreadme`** - README 生成器
102
- - **`split`** - 文件拆分工具
103
- - **`fix_bug`** - Bug 修复流程指南
104
- - **`estimate`** - 工作量估算
105
-
106
- ### 📦 项目管理(8 个工具)
107
- - **`init_setting`** - Cursor AI 配置初始化
108
- - **`init_project`** - Spec-Driven 项目初始化
109
- - **`check_deps`** - 依赖健康度检查
110
- - **`resolve_conflict`** - Git 冲突解决助手
111
- - **`analyze_project`** - 项目分析工具,帮助AI快速理解老项目
112
- - **`init_project_context`** - 初始化项目上下文,生成技术栈和架构文档
113
- - **`add_feature`** - 添加新功能,生成需求/设计/任务文档
114
- - **`start_onboard`** - 快速上手项目(智能编排)
115
-
116
- ### 🚀 智能编排(9 个工具)
117
-
118
- 智能编排工具自动组合多个基础工具,一键完成复杂工作流:
119
-
120
- - **`start_feature`** - 新功能开发:上下文 → 功能规格 → 工作量估算
121
- - **`start_bugfix`** - Bug 修复:上下文 → 分析修复 → 测试 → 提交
122
- - **`start_review`** - 代码体检:上下文 → 质量审查 → 安全扫描 → 性能分析
123
- - **`start_release`** - 发布准备:上下文 → Changelog → PR 描述
124
- - **`start_refactor`** - 代码重构:上下文 → 审查 → 重构 → 测试
125
- - **`start_onboard`** - 快速上手:项目分析 → 生成上下文文档
126
- - **`start_api`** - API 开发:上下文 → API 文档 → Mock 数据 → 测试
127
- - **`start_doc`** - 文档生成:上下文 → 代码注释 → README → API 文档
128
- - **`start_ralph`** - Ralph Loop 循环开发:生成安全模式脚本 → 多轮迭代 → 自动保护 🆕
129
-
130
- ---
131
-
132
- ## 🚀 快速开始
133
-
134
- ### 支持的 MCP 客户端
135
-
136
- 本工具支持所有实现了 MCP 协议的客户端:
137
-
138
- | 客户端 | 配置文件位置 | 说明 |
139
- |--------|-------------|------|
140
- | **Cursor** | `cline_mcp_settings.json` | AI 代码编辑器 |
141
- | **Claude Desktop** | `claude_desktop_config.json` | Anthropic 官方桌面应用 |
142
- | **Cline** | `cline_mcp_settings.json` | VS Code 扩展 |
143
- | **Continue** | `config.json` | VS Code/JetBrains 扩展 |
144
- | **Zed** | `settings.json` | 现代代码编辑器 |
145
- | **其他** | 查看对应文档 | 任何支持 MCP 的工具 |
146
-
147
- ---
148
-
149
- ### 📦 方式一:npx 直接使用(推荐)
150
-
151
- 无需安装,直接使用:
152
-
153
- #### Cursor / Cline 配置
154
-
155
- **配置文件位置:**
156
-
157
- **Windows:**
158
- ```
159
- %APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json
160
- ```
161
-
162
- **macOS:**
163
- ```
164
- ~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
165
- ```
166
-
167
- **Linux:**
168
- ```
169
- ~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
170
- ```
171
-
172
- **配置内容:**
173
- ```json
174
- {
175
- "mcpServers": {
176
- "mcp-probe-kit": {
177
- "command": "npx",
178
- "args": ["mcp-probe-kit@latest"],
179
- "env": {}
180
- }
181
- }
182
- }
183
- ```
184
-
185
- #### Claude Desktop 配置
186
-
187
- **配置文件位置:**
188
-
189
- **Windows:**
190
- ```
191
- %APPDATA%\Claude\claude_desktop_config.json
192
- ```
193
-
194
- **macOS:**
195
- ```
196
- ~/Library/Application Support/Claude/claude_desktop_config.json
197
- ```
198
-
199
- **Linux:**
200
- ```
201
- ~/.config/Claude/claude_desktop_config.json
202
- ```
203
-
204
- **配置内容:**
205
- ```json
206
- {
207
- "mcpServers": {
208
- "mcp-probe-kit": {
209
- "command": "npx",
210
- "args": ["-y", "mcp-probe-kit@latest"]
211
- }
212
- }
213
- }
214
- ```
215
-
216
- #### Continue 配置
217
-
218
- **配置文件位置:**
219
- ```
220
- ~/.continue/config.json
221
- ```
222
-
223
- **配置内容:**
224
- ```json
225
- {
226
- "experimental": {
227
- "modelContextProtocolServers": [
228
- {
229
- "transport": {
230
- "type": "stdio",
231
- "command": "npx",
232
- "args": ["-y", "mcp-probe-kit@latest"]
233
- }
234
- }
235
- ]
236
- }
237
- }
238
- ```
239
-
240
- ### 📦 方式二:全局安装
241
-
242
- ```bash
243
- # 全局安装
244
- npm install -g mcp-probe-kit
245
- ```
246
-
247
- #### Cursor / Cline 配置
248
-
249
- **配置内容:**
250
- ```json
251
- {
252
- "mcpServers": {
253
- "mcp-probe-kit": {
254
- "command": "mcp-probe-kit"
255
- }
256
- }
257
- }
258
- ```
259
-
260
- #### Claude Desktop 配置
261
-
262
- **配置内容:**
263
- ```json
264
- {
265
- "mcpServers": {
266
- "mcp-probe-kit": {
267
- "command": "mcp-probe-kit"
268
- }
269
- }
270
- }
271
- ```
272
-
273
- ---
274
-
275
- ### 📦 方式三:本地项目安装
276
-
277
- ```bash
278
- # 在项目中安装
279
- npm install mcp-probe-kit
280
- ```
281
-
282
- #### Cursor / Cline 配置
283
-
284
- **配置内容:**
285
- ```json
286
- {
287
- "mcpServers": {
288
- "mcp-probe-kit": {
289
- "command": "node",
290
- "args": ["./node_modules/mcp-probe-kit/build/index.js"]
291
- }
292
- }
293
- }
294
- ```
295
-
296
- #### Claude Desktop 配置
297
-
298
- **配置内容:**
299
- ```json
300
- {
301
- "mcpServers": {
302
- "mcp-probe-kit": {
303
- "command": "node",
304
- "args": ["./node_modules/mcp-probe-kit/build/index.js"]
305
- }
306
- }
307
- }
308
- ```
309
-
310
- ---
311
-
312
- ### 🔧 开发模式(本地开发)
313
-
314
- 如果你在本地开发或修改工具:
315
-
316
- #### Cursor / Cline
317
-
318
- **Windows:**
319
- ```
320
- %APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json
321
- ```
322
-
323
- **macOS:**
324
- ```
325
- ~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
326
- ```
327
-
328
- **配置内容:**
329
- ```json
330
- {
331
- "mcpServers": {
332
- "mcp-probe-kit": {
333
- "command": "node",
334
- "args": ["D:/workspace/github/mcp-probe-kit/build/index.js"]
335
- }
336
- }
337
- }
338
- ```
339
-
340
- ⚠️ **重要**:将路径修改为你的实际项目路径
341
-
342
- #### Claude Desktop
343
-
344
- **配置内容:**
345
- ```json
346
- {
347
- "mcpServers": {
348
- "mcp-probe-kit": {
349
- "command": "node",
350
- "args": ["/path/to/your/mcp-probe-kit/build/index.js"]
351
- }
352
- }
353
- }
354
- ```
355
-
356
- ### 🔄 重启客户端
357
-
358
- 配置完成后,**重启你的 MCP 客户端**:
359
- - **Cursor**: 完全退出后重新打开(不是重新加载窗口)
360
- - **Claude Desktop**: 退出后重新打开
361
- - **VS Code (Cline/Continue)**: 重新加载窗口(Ctrl/Cmd + Shift + P → Reload Window)
362
-
363
- ---
364
-
365
- ## 📖 工具使用指南
366
-
367
- ### 🎯 访谈工具 🆕
368
-
369
- #### `interview` - 需求访谈模式
370
-
371
- 在开发前通过结构化访谈澄清需求,避免理解偏差和返工。
372
-
373
- **核心理念**: 先慢下来,把问题想清楚,反而能更快地交付正确的解决方案。
374
-
375
- **用法**:
376
- ```
377
- interview "实现用户登录功能"
378
- ```
379
-
380
- **访谈内容**:
381
- - **阶段 1**: 背景理解(3个问题)- 痛点、用户、业务驱动
382
- - **阶段 2**: 功能边界(4个问题)- 核心价值、范围、输入输出
383
- - **阶段 3**: 技术约束(4个问题)- 技术栈、性能、兼容性、安全
384
- - **阶段 4**: 验收标准(3个问题)- 成功标准、测试场景、效果衡量
385
-
386
- **工作流程**:
387
- ```
388
- 1. AI: interview "登录功能"
389
-
390
- 2. 生成 12-15 个结构化问题
391
-
392
- 3. 用户回答所有问题
393
-
394
- 4. AI 生成 docs/interviews/user-login-interview.md
395
-
396
- 5. 用户选择:
397
- - 立即开发: start_feature --from-interview user-login
398
- - 生成规格: add_feature --from-interview user-login
399
- - 稍后开发: 访谈记录已保存,随时可用
400
- ```
401
-
402
- **适用场景**:
403
- - ✅ 需求不明确的新功能
404
- - ✅ 复杂的业务功能
405
- - ✅ 涉及多方协作的功能
406
- - ❌ 简单的 Bug 修复
407
- - ❌ 需求非常明确的功能
408
-
409
- **详细文档**: 查看 [Interview 使用指南](docs/INTERVIEW_GUIDE.md)
410
-
411
- ---
412
-
413
- #### `ask_user` - 通用提问工具
414
-
415
- AI 可在任何时候主动向用户提问,澄清不确定的信息。
416
-
417
- **用法**:
418
- ```
419
- ask_user "你希望支持哪些支付方式?"
420
- ask_user --questions ["问题1", "问题2"] --context "背景信息"
421
- ```
422
-
423
- **功能特点**:
424
- - 支持单个或多个问题
425
- - 可提供选项供用户选择
426
- - 可标注必答/可选
427
- - 可在任何工具中使用
428
-
429
- **使用场景**:
430
- ```
431
- 场景1: 代码审查时
432
- AI: "发现了性能问题,但不确定优先级"
433
- 调用: ask_user "这个性能问题的优先级如何?是否需要立即优化?"
434
-
435
- 场景2: 技术方案选择
436
- AI: "可以用两种方案,不确定你的偏好"
437
- 调用: ask_user --options ["方案A: 性能优先", "方案B: 可读性优先"]
438
-
439
- 场景3: Bug 修复时
440
- AI: "需要确认是否向后兼容"
441
- 调用: ask_user "修复这个 Bug 是否需要保持向后兼容?"
442
- ```
443
-
444
- ---
445
-
446
- ### 🔍 代码质量工具
447
-
448
- #### `detect_shell` - 套壳检测
449
- 检测 AI 模型是否被代理/包装,生成 JSON 指纹验证。
450
-
451
- **用法**:`detect_shell`
452
-
453
- ---
454
-
455
- #### `code_review` - 代码审查
456
- 全面审查代码质量、安全性、性能和最佳实践。
457
-
458
- **用法**:`code_review` 或 `code_review @file.ts`
459
-
460
- **审查内容**:代码坏味道、安全漏洞、性能问题、命名规范
461
-
462
- ---
463
-
464
- #### `debug` - 调试助手
465
- 分析错误并生成调试策略和解决方案。
466
-
467
- **用法**:`debug` 然后粘贴错误信息
468
-
469
- **输出**:错误分类、问题定位、调试步骤、解决方案、验证清单
470
-
471
- ---
472
-
473
- #### `gentest` - 测试生成
474
- 为代码生成完整的测试用例(支持 Jest/Vitest/Mocha)。
475
-
476
- **用法**:`gentest @function.ts`
477
-
478
- **生成内容**:单元测试、边界测试、异常测试、Mock 数据
479
-
480
- ---
481
-
482
- #### `refactor` - 重构建议
483
- 分析代码并提供重构建议和实施计划。
484
-
485
- **用法**:`refactor @messy-code.ts`
486
-
487
- **建议内容**:识别代码坏味道、重构步骤、风险评估、预期收益
488
-
489
- ---
490
-
491
- #### `perf` - 性能分析
492
- 分析代码性能瓶颈并提供优化建议。
493
-
494
- **用法**:`perf @slow-function.ts`
495
-
496
- **分析维度**:算法复杂度、内存使用、React 性能、数据库查询
497
-
498
- ---
499
-
500
- #### `fix` - 自动修复
501
- 自动修复代码问题(Lint 错误、TypeScript 类型错误、格式化问题)。
502
-
503
- **用法**:`fix @file.ts` 或 `fix`(修复所有文件)
504
-
505
- **修复类型**:lint, type, format, import, unused, all(默认)
506
-
507
- **功能**:
508
- - Lint 错误自动修复
509
- - TypeScript 类型错误修复
510
- - 代码格式化
511
- - Import 语句优化
512
- - 移除未使用代码
513
-
514
- ---
515
-
516
- #### `security_scan` - 安全扫描 🆕
517
- 全面扫描代码安全漏洞,检测注入、认证、加密等问题。
518
-
519
- **用法**:`security_scan @file.ts`
520
-
521
- **扫描类型**:
522
- - **all**(默认)- 全面扫描
523
- - **injection** - 注入类漏洞(SQL注入、XSS、命令注入)
524
- - **auth** - 认证授权问题
525
- - **crypto** - 加密安全问题
526
- - **sensitive_data** - 敏感数据泄露
527
-
528
- **检测内容**:
529
- - SQL 注入、XSS、命令注入
530
- - 硬编码密码/密钥
531
- - 弱加密算法(MD5、SHA1)
532
- - 不安全随机数
533
- - 日志泄露敏感信息
534
- - 错误信息泄露
535
-
536
- **输出**:
537
- - 漏洞摘要(按严重程度分类)
538
- - 详细漏洞列表(含 CWE 编号)
539
- - 修复建议和示例代码
540
- - 安全最佳实践
541
-
542
- ---
543
-
544
- ### 🛠️ 开发效率工具
545
-
546
- #### `gencommit` - 提交生成
547
- 自动分析代码变更,生成规范的 Git commit 消息(支持 emoji)。
548
-
549
- **用法**:`gencommit`
550
-
551
- **格式**:`<type>: <emoji> <subject>` (遵循 Conventional Commits)
552
-
553
- **类型**:
554
- - `fixed` 🐛 - 线上/测试缺陷修复
555
- - `fix` 🐛 - 语义同 fixed,保持兼容
556
- - `feat` 🎸 - 新增或迭代业务功能
557
- - `docs` ✏️ - 文档相关更新
558
- - `style` 💄 - UI/样式调整
559
- - `chore` 🤖 - 构建、脚本、依赖等杂项
560
- - `refactor` ♻️ - 重构
561
- - `test` ✅ - 测试相关
562
-
563
- **示例**:
564
- ```bash
565
- feat: 🎸 添加用户登录功能
566
-
567
- 影响模块: auth
568
- - 实现 JWT 认证机制
569
- - 添加密码加密存储
570
- ```
571
-
572
- ---
573
-
574
- #### `genapi` - 文档生成
575
- 为代码生成 API 文档(支持 Markdown/OpenAPI/JSDoc)。
576
-
577
- **用法**:`genapi @api/user.ts`
578
-
579
- **格式**:markdown(默认), openapi, jsdoc
580
-
581
- ---
582
-
583
- #### `gendoc` - 注释生成
584
- 为代码生成详细的 JSDoc/TSDoc 注释。
585
-
586
- **用法**:`gendoc @function.ts`
587
-
588
- **包含**:函数描述、参数说明、返回值、异常情况、使用示例
589
-
590
- ---
591
-
592
- #### `genpr` - PR 生成
593
- 分析变更并生成规范的 Pull Request 描述。
594
-
595
- **用法**:`genpr`
596
-
597
- **包含**:变更摘要、技术细节、测试说明、注意事项、Checklist
598
-
599
- ---
600
-
601
- #### `genchangelog` - Changelog 生成
602
- 根据 commit 历史生成 CHANGELOG.md。
603
-
604
- **用法**:`genchangelog v1.2.0`
605
-
606
- **格式**:Keep a Changelog 标准
607
-
608
- ---
609
-
610
- #### `gensql` - SQL 生成器
611
- 根据自然语言描述生成 SQL 查询语句。
612
-
613
- **用法**:`gensql` 然后描述需求(如:"查询购买金额超过平均值的用户")
614
-
615
- **支持**:PostgreSQL, MySQL, SQLite
616
-
617
- **功能**:
618
- - 复杂查询生成(JOIN、子查询、窗口函数)
619
- - 建表语句生成
620
- - 索引优化建议
621
- - 查询性能分析
622
-
623
- ---
624
-
625
- #### `genui` - UI 组件生成器(React + Vue)
626
- 生成 React 或 Vue 3 UI 组件代码。
627
-
628
- **用法**:`genui` 然后描述组件(如:"创建一个带加载状态的 Button 组件")
629
-
630
- **支持框架**:
631
- - **React**: Hooks、forwardRef、TypeScript
632
- - **Vue 3**: Composition API、script setup、TypeScript
633
- - **HTML**: 原生 JavaScript
634
-
635
- **功能**:
636
- - 完整的组件实现(TypeScript)
637
- - Tailwind CSS / UnoCSS 样式
638
- - 可访问性(A11y)支持
639
- - Props/Emits 类型定义
640
- - 使用示例和最佳实践
641
- - 组件库推荐(shadcn/ui、Element Plus 等)
642
-
643
- ---
644
-
645
- #### `explain` - 代码解释器
646
- 详细解释代码逻辑和原理,帮助理解复杂代码。
647
-
648
- **用法**:`explain @complex-code.ts`
649
-
650
- **解释内容**:
651
- - 整体功能概述
652
- - 逐行代码说明
653
- - 核心原理分析
654
- - 设计模式识别
655
- - 时间/空间复杂度
656
- - 使用场景和注意事项
657
-
658
- **适用场景**:
659
- - 理解遗留代码
660
- - 学习新框架/库
661
- - 复杂算法分析
662
- - Code Review
663
-
664
- ---
665
-
666
- #### `convert` - 代码转换器
667
- 转换代码格式或框架。
668
-
669
- **用法**:`convert @file.js` 然后说明转换类型(如:"转为 TypeScript")
670
-
671
- **支持转换**:
672
- - JavaScript → TypeScript
673
- - Class Component → Hooks
674
- - Promises → Async/Await
675
- - CommonJS → ESM
676
- - CSS → Tailwind CSS
677
- - Vue 2 → Vue 3
678
- - JSON → TypeScript Interface
679
-
680
- ---
681
-
682
- #### `css_order` - CSS 顺序规范
683
- 按规则书写或重排 CSS 属性顺序。
684
-
685
- **用法**:`css_order`
686
-
687
- **包含**:由外向内排序逻辑、五大类属性划分、常用属性示例、快速对比表、重排要求
688
-
689
- ---
690
-
691
- #### `genreadme` - README 生成器
692
- 根据项目代码自动生成 README.md 文档。
693
-
694
- **用法**:`genreadme` 或提供项目信息
695
-
696
- **风格**:standard(标准), minimal(极简), detailed(详细)
697
-
698
- **包含内容**:
699
- - 项目简介和徽章
700
- - 安装和快速开始
701
- - 功能特性列表
702
- - 使用示例
703
- - API 文档
704
- - 配置说明
705
- - 贡献指南
706
-
707
- ---
708
-
709
- #### `split` - 文件拆分工具
710
- 将大文件拆分成多个小文件或小组件,提高可维护性。
711
-
712
- **用法**:`split @LargeFile.tsx` 或提供文件内容
713
-
714
- **拆分策略**:
715
- - **auto**(自动)- AI 分析最佳拆分方式
716
- - **type**(按类型)- 分离类型定义、常量、工具函数
717
- - **function**(按功能)- 将多个独立函数拆分
718
- - **component**(按组件)- 拆分 React/Vue 组件为子组件
719
- - **feature**(按模块)- 拆分功能模块(如 Redux store)
720
-
721
- **适用场景**:
722
- - 超过 300 行的文件
723
- - 职责过多的组件
724
- - 工具函数大杂烩
725
- - 难以维护的代码
726
-
727
- **提供方案**:
728
- - 拆分策略分析
729
- - 建议的目录结构
730
- - 每个新文件的内容
731
- - 导入导出关系
732
- - 迁移步骤
733
-
734
- ---
735
-
736
- #### `fix_bug` - Bug 修复流程 🆕
737
- 指导完整的 Bug 修复流程,从问题定位到验证测试。
738
-
739
- **用法**:`fix_bug` 然后提供错误信息
740
-
741
- **参数**:
742
- - `error_message` - 错误信息(必填)
743
- - `stack_trace` - 堆栈跟踪(可选)
744
- - `steps_to_reproduce` - 复现步骤(可选)
745
- - `expected_behavior` - 期望行为(可选)
746
- - `actual_behavior` - 实际行为(可选)
747
-
748
- **修复流程**:
749
- 1. **问题定位** - 分析错误信息和堆栈,定位问题代码
750
- 2. **原因分析** - 使用 5 Whys 方法分析根本原因
751
- 3. **修复方案** - 设计修复方案,评估风险
752
- 4. **验证测试** - 生成测试用例,确保修复有效
753
-
754
- **输出**:
755
- - 问题定位结论
756
- - 根本原因分析
757
- - 修复方案和代码
758
- - 测试用例
759
- - 修复检查清单
760
-
761
- ---
762
-
763
- #### `estimate` - 工作量估算 🆕
764
- 评估开发任务的工作量,提供故事点和时间估算。
765
-
766
- **用法**:`estimate` 然后描述任务
767
-
768
- **参数**:
769
- - `task_description` - 任务描述(必填)
770
- - `code_context` - 相关代码(可选)
771
- - `team_size` - 团队规模(可选,默认 1)
772
- - `experience_level` - 经验水平(可选,默认 mid)
773
-
774
- **估算维度**:
775
- - **代码量** - 预估新增/修改行数
776
- - **技术难度** - 1-5 级评分
777
- - **依赖复杂度** - 涉及的模块数
778
- - **测试复杂度** - 需要的测试类型
779
-
780
- **输出**:
781
- - 故事点估算(1/2/3/5/8/13)
782
- - 时间估算(乐观/正常/悲观)
783
- - 复杂度分析
784
- - 风险识别
785
- - 任务分解建议(如超过 8 小时)
786
-
787
- ---
788
-
789
- #### `gen_skill` - Agent Skills 文档生成器 🆕
790
- 生成符合 Agent Skills 开放标准的技能文档,供 AI 助手发现和使用。
791
-
792
- **用法**:`gen_skill` 或 `gen_skill code_review`
793
-
794
- **参数**:
795
- - `scope` - 生成范围:all(全部)、basic、generation、analysis、refactoring、workflow、context、orchestration(默认 all)
796
- - `tool_name` - 指定单个工具名称(优先级高于 scope)
797
- - `output_dir` - 输出目录(默认 skills)
798
- - `lang` - 文档语言:zh、en(默认 zh)
799
-
800
- **生成内容**:
801
- - 符合 [Agent Skills 开放标准](https://agentskills.io) 的 SKILL.md 文件
802
- - YAML frontmatter(name、description、compatibility、metadata)
803
- - 功能描述、使用场景、参数说明
804
- - 调用示例和相关工具
805
- - README 索引文件
806
-
807
- **适用场景**:
808
- - 🤖 让 AI 助手自动发现和使用 MCP 工具
809
- - 📚 生成标准化的工具文档
810
- - 🔗 兼容 Claude、Gemini、OpenCode 等平台
811
-
812
- **示例**:
813
- ```
814
- # 生成所有工具的技能文档
815
- gen_skill
816
-
817
- # 只生成分析类工具
818
- gen_skill --scope analysis
819
-
820
- # 生成单个工具
821
- gen_skill --tool_name code_review
822
-
823
- # 生成英文文档
824
- gen_skill --lang en
825
- ```
826
-
827
- ---
828
-
829
- #### `gen_mock` - Mock 数据生成 🆕
830
- 根据数据结构生成符合语义的模拟数据。
831
-
832
- **用法**:`gen_mock` 然后提供数据结构
833
-
834
- **参数**:
835
- - `schema` - 数据结构(TypeScript interface 或 JSON Schema)
836
- - `count` - 生成数量(默认 1,最大 1000)
837
- - `format` - 输出格式(json/typescript/javascript/csv)
838
- - `locale` - 语言区域(zh-CN/en-US)
839
- - `seed` - 随机种子(可重复生成)
840
-
841
- **智能识别**:
842
- - 根据字段名自动识别语义(name→人名、email→邮箱)
843
- - 支持中英文数据生成
844
- - 自动处理关联数据
845
-
846
- **字段识别**:
847
- - id → UUID
848
- - name → 人名
849
- - email → 邮箱格式
850
- - phone → 手机号
851
- - address → 地址
852
- - date → 日期时间
853
- - price → 金额
854
- - status → 枚举值
855
-
856
- **输出格式**:
857
- - JSON - 标准 JSON 数组
858
- - TypeScript - 带类型定义
859
- - JavaScript - CommonJS/ESM
860
- - CSV - 表格数据(仅扁平结构)
861
-
862
- ---
863
-
864
- #### `design2code` - 设计稿转代码 🆕
865
- 1:1 还原设计稿或将 HTML 转换为 Vue/React 项目页面。
866
-
867
- **用法**:`design2code` 然后提供设计稿
868
-
869
- **输入方式**:
870
- - **图片 URL** - 设计稿图片链接(支持 jpg/png/gif/webp/svg)
871
- - **Base64 图片** - 直接粘贴 base64 编码的图片
872
- - **设计稿描述** - 用文字描述页面布局和功能
873
- - **HTML 代码** - 现有的 HTML 代码
874
-
875
- **参数**:
876
- - `input` - 设计稿图片/描述/HTML(必填)
877
- - `framework` - vue/react(默认 vue)
878
- - `style_solution` - tailwind/css-modules/styled-components(默认 tailwind)
879
- - `component_type` - page/component(默认 page)
880
-
881
- **功能特性**:
882
- - 🎨 **精确还原** - 1:1 还原布局、颜色、字体、间距
883
- - 📱 **响应式设计** - 自动生成移动端/平板/桌面端适配
884
- - 🧩 **组件化** - 智能拆分可复用组件
885
- - 💎 **TypeScript** - 完整的类型定义
886
- - ♿ **可访问性** - 语义化 HTML + ARIA 属性
887
- - ⚡ **性能优化** - 图片懒加载、代码分割
888
-
889
- **适用场景**:
890
- - 🎨 UI 设计稿转前端代码
891
- - 🔄 HTML 页面迁移到 Vue/React
892
- - 📄 落地页快速开发
893
- - 🎯 原型转生产代码
894
-
895
- **输出内容**:
896
- - 完整的组件代码(Vue 3 Composition API / React Hooks)
897
- - TypeScript 类型定义
898
- - Tailwind CSS 样式(或其他方案)
899
- - 使用示例和说明
900
- - 响应式断点设计
901
- - 性能优化建议
902
-
903
- **示例**:
904
- ```
905
- # 图片转代码
906
- design2code https://example.com/design.png
907
-
908
- # 描述转代码
909
- design2code "创建一个登录页面,包含用户名、密码输入框和登录按钮"
910
-
911
- # HTML 转 Vue
912
- design2code <div class="container">...</div>
913
- ```
914
-
915
- ---
916
-
917
- ### 📦 项目管理工具
918
-
919
- #### `init_setting` - 配置初始化
920
- 在当前项目创建 Cursor AI 配置文件。
921
-
922
- **用法**:`init_setting`
923
-
924
- **配置**:Claude Sonnet 4.5, temperature=0, semantic 检索
925
-
926
- ---
927
-
928
- #### `init_project` - 项目初始化
929
- 按 Spec-Driven Development 方式初始化项目。
930
-
931
- **用法**:`init_project,需求是:创建任务管理系统` 或 `init_project @requirements.md`
932
-
933
- **生成**:constitution.md, spec.md, plan.md, tasks.md, research.md
934
-
935
- **参考**:[GitHub Spec-Kit](https://github.com/github/spec-kit)
936
-
937
- ---
938
-
939
- #### `check_deps` - 依赖检查
940
- 分析项目依赖的健康度(版本、安全、体积)。
941
-
942
- **用法**:`check_deps`
943
-
944
- **检查**:过期依赖、安全漏洞、包体积、未使用依赖
945
-
946
- ---
947
-
948
- #### `resolve_conflict` - Git 冲突解决
949
- 分析并帮助解决 Git 合并冲突。
950
-
951
- **用法**:`resolve_conflict` 然后粘贴冲突内容,或直接打开冲突文件
952
-
953
- **功能**:
954
- - 冲突原因分析
955
- - 双方修改意图识别
956
- - 推荐合并方案
957
- - 完整的解决后代码
958
- - 冲突预防建议
959
-
960
- **适用场景**:
961
- - Feature 分支合并
962
- - Rebase 冲突
963
- - Cherry-pick 冲突
964
-
965
- ---
966
-
967
- #### `analyze_project` - 项目分析工具
968
- 深度分析项目结构、代码质量和架构,帮助AI快速理解老项目。
969
-
970
- **用法**:`analyze_project` 或 `analyze_project @project-path`
971
-
972
- **参数**:
973
- - `project_path` - 项目路径(默认当前目录)
974
- - `max_depth` - 目录树最大深度(默认 5)
975
- - `include_content` - 是否包含文件内容(默认 true)
976
-
977
- **分析内容**:
978
- - **项目概览**:项目类型、技术栈、框架、语言、包管理器
979
- - **目录结构**:清晰的目录树展示
980
- - **关键文件**:自动识别重要配置文件并提供用途说明
981
- - **依赖分析**:生产依赖、开发依赖统计和健康度评估
982
- - **代码指标**:文件数量、行数统计、文件类型分布、最大文件识别
983
- - **架构模式**:设计模式检测、入口文件识别、核心模块分析
984
- - **智能建议**:项目复杂度评估和改进建议
985
-
986
- **适用场景**:
987
- - 🔍 接手老项目时快速了解项目结构
988
- - 📊 代码审查前进行项目概览
989
- - 🏗️ 架构分析和重构规划
990
- - 📚 项目文档生成
991
- - 🤖 AI助手更好地理解项目上下文
992
-
993
- ---
994
-
995
- #### `init_project_context` - 初始化项目上下文 🆕
996
- 生成项目上下文文档,记录技术栈、架构和规范,供后续功能开发参考。
997
-
998
- **用法**:`init_project_context`
999
-
1000
- **参数**:
1001
- - `docs_dir` - 文档目录(默认 docs)
1002
-
1003
- **生成内容**:
1004
- - 项目概览(名称、版本、类型)
1005
- - 技术栈(语言、框架、构建工具)
1006
- - 项目结构(目录树、入口文件)
1007
- - 架构模式(设计模式、模块划分)
1008
- - 编码规范(ESLint、Prettier、命名规范)
1009
- - 依赖管理(主要依赖列表)
1010
- - 开发流程(常用命令)
1011
-
1012
- **输出文件**:`docs/project-context.md`
1013
-
1014
- **适用场景**:
1015
- - 🆕 新项目初始化后记录项目信息
1016
- - 📚 为 AI 提供项目上下文
1017
- - 🔄 功能开发前了解项目规范
1018
-
1019
- ---
1020
-
1021
- #### `add_feature` - 添加新功能 🆕
1022
- 为已有项目生成新功能的规格文档(需求、设计、任务清单)。
1023
-
1024
- **用法**:`add_feature` 然后提供功能名称和描述
1025
-
1026
- **参数**:
1027
- - `feature_name` - 功能名称(必填,kebab-case 格式,如 user-auth)
1028
- - `description` - 功能描述(必填)
1029
- - `docs_dir` - 文档目录(默认 docs)
1030
-
1031
- **生成文件**:
1032
- - `docs/specs/{feature_name}/requirements.md` - 需求文档(EARS 格式)
1033
- - `docs/specs/{feature_name}/design.md` - 设计文档
1034
- - `docs/specs/{feature_name}/tasks.md` - 任务清单
1035
-
1036
- **适用场景**:
1037
- - 🎯 规范化功能开发流程
1038
- - 📋 Spec-Driven Development
1039
- - 🤖 AI 辅助功能实现
1040
-
1041
16
  ---
1042
17
 
1043
- ### 🚀 智能编排工具
1044
-
1045
- 智能编排工具自动组合多个基础工具,一键完成复杂工作流。所有编排工具都会自动检查并生成项目上下文。
1046
-
1047
- #### `start_feature` - 新功能开发 🆕
1048
- 一键完成新功能开发的完整流程。
1049
-
1050
- **用法**:`start_feature user-auth "用户登录认证功能"`
18
+ ## 📚 完整文档
1051
19
 
1052
- **参数**:
1053
- - `feature_name` - 功能名称(必填)
1054
- - `description` - 功能描述(必填)
1055
- - `docs_dir` - 文档目录(可选)
20
+ **👉 [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)**
1056
21
 
1057
- **编排流程**:
1058
- ```
1059
- 检查/生成项目上下文
1060
-
1061
- 调用 add_feature 生成功能规格
1062
-
1063
- 调用 estimate 进行工作量估算
1064
-
1065
- 输出完整报告
1066
- ```
1067
-
1068
- **输出**:
1069
- - 完整的功能规格文档(需求/设计/任务)
1070
- - 工作量估算(故事点 + 时间)
1071
- - 风险识别
1072
- - 下一步建议
22
+ - [快速开始](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html) - 5分钟完成安装配置
23
+ - [所有工具](https://mcp-probe-kit.bytezonex.com/pages/all-tools.html) - 39个工具完整列表
24
+ - [最佳实践](https://mcp-probe-kit.bytezonex.com/pages/examples.html) - 完整研发流程实战指南
25
+ - [迁移指南](https://mcp-probe-kit.bytezonex.com/pages/migration.html) - 版本升级指南
1073
26
 
1074
27
  ---
1075
28
 
1076
- #### `start_bugfix` - Bug 修复 🆕
1077
- 一键完成 Bug 修复的完整流程。
29
+ ## 核心特性
1078
30
 
1079
- **用法**:`start_bugfix` 然后提供错误信息
31
+ ### 📦 39 个实用工具
1080
32
 
1081
- **参数**:
1082
- - `error_message` - 错误信息(必填)
1083
- - `stack_trace` - 堆栈跟踪(可选)
33
+ - **🔄 工作流编排** (10个) - 一键完成复杂开发流程
34
+ - **🔍 代码分析** (7个) - 代码审查、调试、性能优化
35
+ - **🌿 Git 工具** (4个) - 自动生成 commit、PR、changelog
36
+ - **✨ 生成工具** (7个) - 文档、测试、Mock 数据生成
37
+ - **📋 项目管理** (7个) - 需求分析、工作量估算、项目分析
38
+ - **🎨 UI/UX 工具** (6个) - 设计系统、组件生成、设计稿转代码
39
+ - **🔧 其他工具** (7个) - 代码修复、格式转换、依赖检查
1084
40
 
1085
- **编排流程**:
1086
- ```
1087
- 检查/生成项目上下文
1088
-
1089
- 调用 fix_bug 分析修复
1090
-
1091
- 调用 gentest 生成测试
1092
-
1093
- 输出完整报告
1094
- ```
41
+ ### 🎯 结构化输出
1095
42
 
1096
- **输出**:
1097
- - Bug 原因分析
1098
- - 修复方案和代码
1099
- - 回归测试代码
43
+ 所有工具都支持**结构化输出**,返回机器可读的 JSON 数据,提高 AI 解析准确性,支持工具串联和状态追踪。
1100
44
 
1101
- ---
45
+ ### 🔄 工作流编排
1102
46
 
1103
- #### `start_review` - 代码体检 🆕
1104
- 一键完成代码全面体检。
47
+ 10 个智能编排工具,自动组合多个基础工具,一键完成复杂开发流程:
48
+ - `start_feature` - 新功能开发(需求 → 设计 → 估算)
49
+ - `start_bugfix` - Bug 修复(分析 → 修复 → 测试)
50
+ - `start_review` - 代码体检(质量 → 安全 → 性能)
51
+ - `start_ui` - UI 开发(设计系统 → 组件 → 代码)
52
+ - 更多...
1105
53
 
1106
- **用法**:`start_review @file.ts`
54
+ ### 🎨 UI/UX Pro Max
1107
55
 
1108
- **参数**:
1109
- - `code` - 需要审查的代码(必填)
1110
- - `language` - 编程语言(可选)
56
+ 6 个 UI/UX 工具,从设计系统到代码生成:
57
+ - `ui_design_system` - 智能设计系统生成
58
+ - `start_ui` - 一键 UI 开发(支持智能模式)
59
+ - `design2code` - 设计稿转代码
60
+ - `ui_search` - UI/UX 数据搜索
61
+ - 更多...
1111
62
 
1112
- **编排流程**:
1113
- ```
1114
- 检查/生成项目上下文
1115
-
1116
- 调用 code_review 质量审查
1117
-
1118
- 调用 security_scan 安全扫描
1119
-
1120
- 调用 perf 性能分析
1121
-
1122
- 生成综合报告
1123
- ```
63
+ ### 🎤 需求访谈
1124
64
 
1125
- **输出**:
1126
- - 代码质量评分
1127
- - 安全漏洞报告
1128
- - 性能优化建议
1129
- - 综合修复优先级
65
+ 2 个访谈工具,在开发前澄清需求:
66
+ - `interview` - 结构化需求访谈
67
+ - `ask_user` - AI 主动提问
1130
68
 
1131
69
  ---
1132
70
 
1133
- #### `start_release` - 发布准备 🆕
1134
- 一键完成版本发布准备。
1135
-
1136
- **用法**:`start_release v1.2.0`
1137
-
1138
- **参数**:
1139
- - `version` - 版本号(必填,如 v1.2.0)
1140
- - `from_tag` - 起始 tag(可选)
1141
- - `branch` - 分支名称(可选)
1142
-
1143
- **编排流程**:
1144
- ```
1145
- 检查/生成项目上下文
1146
-
1147
- 调用 genchangelog 生成变更日志
1148
-
1149
- 调用 genpr 生成 PR 描述
1150
-
1151
- 输出发布清单
1152
- ```
1153
-
1154
- **输出**:
1155
- - CHANGELOG.md 内容
1156
- - PR 描述
1157
- - 发布检查清单
71
+ ## 🚀 快速开始
1158
72
 
1159
- ---
73
+ ### 方式一:npx 直接使用(推荐)
1160
74
 
1161
- #### `start_refactor` - 代码重构 🆕
1162
- 一键完成代码重构流程。
75
+ 无需安装,直接使用最新版本。
1163
76
 
1164
- **用法**:`start_refactor @legacy-code.ts`
77
+ #### Cursor / Cline 配置
1165
78
 
1166
- **参数**:
1167
- - `code` - 需要重构的代码(必填)
1168
- - `goal` - 重构目标(可选)
79
+ **配置文件位置:**
80
+ - Windows: `%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`
81
+ - macOS: `~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
82
+ - Linux: `~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
1169
83
 
1170
- **编排流程**:
1171
- ```
1172
- 检查/生成项目上下文
1173
-
1174
- 调用 code_review 发现问题
1175
-
1176
- 调用 refactor 生成重构方案
1177
-
1178
- 调用 gentest 生成保护测试
1179
-
1180
- 输出重构报告
84
+ **配置内容:**
85
+ ```json
86
+ {
87
+ "mcpServers": {
88
+ "mcp-probe-kit": {
89
+ "command": "npx",
90
+ "args": ["mcp-probe-kit@latest"]
91
+ }
92
+ }
93
+ }
1181
94
  ```
1182
95
 
1183
- **输出**:
1184
- - 问题清单
1185
- - 重构前后对比
1186
- - 改进说明
1187
- - 测试代码
1188
-
1189
- ---
1190
-
1191
- #### `start_onboard` - 快速上手 🆕
1192
- 一键快速了解项目。
1193
-
1194
- **用法**:`start_onboard`
96
+ #### Claude Desktop 配置
1195
97
 
1196
- **参数**:
1197
- - `project_path` - 项目路径(可选)
1198
- - `docs_dir` - 文档目录(可选)
98
+ **配置文件位置:**
99
+ - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
100
+ - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
101
+ - Linux: `~/.config/Claude/claude_desktop_config.json`
1199
102
 
1200
- **编排流程**:
1201
- ```
1202
- 调用 analyze_project 分析项目
1203
-
1204
- 调用 init_project_context 生成上下文
1205
-
1206
- 输出项目概览
103
+ **配置内容:**
104
+ ```json
105
+ {
106
+ "mcpServers": {
107
+ "mcp-probe-kit": {
108
+ "command": "npx",
109
+ "args": ["-y", "mcp-probe-kit@latest"]
110
+ }
111
+ }
112
+ }
1207
113
  ```
1208
114
 
1209
- **输出**:
1210
- - 项目概览(类型、技术栈)
1211
- - 项目结构
1212
- - 核心文件说明
1213
- - 快速开始指南
1214
- - 项目上下文文档
1215
-
1216
- ---
1217
-
1218
- #### `start_api` - API 开发 🆕
1219
- 一键完成 API 开发资料生成。
115
+ ### 方式二:全局安装
1220
116
 
1221
- **用法**:`start_api @api/user.ts`
1222
-
1223
- **参数**:
1224
- - `code` - API 代码(必填)
1225
- - `language` - 编程语言(可选)
1226
- - `format` - 文档格式(可选)
1227
-
1228
- **编排流程**:
1229
- ```
1230
- 检查/生成项目上下文
1231
-
1232
- 调用 genapi 生成 API 文档
1233
-
1234
- 调用 gen_mock 生成 Mock 数据
1235
-
1236
- 调用 gentest 生成 API 测试
1237
-
1238
- 输出完整资料
117
+ ```bash
118
+ npm install -g mcp-probe-kit
1239
119
  ```
1240
120
 
1241
- **输出**:
1242
- - API 文档
1243
- - Mock 数据
1244
- - 测试代码
1245
- - 使用建议
1246
-
1247
- ---
1248
-
1249
- #### `start_doc` - 文档生成 🆕
1250
- 一键生成完整的项目文档。
1251
-
1252
- **用法**:`start_doc @src/`
1253
-
1254
- **参数**:
1255
- - `code` - 代码或项目信息(必填)
1256
- - `style` - 注释风格(可选)
1257
- - `lang` - 语言(可选)
1258
-
1259
- **编排流程**:
1260
- ```
1261
- 检查/生成项目上下文
1262
-
1263
- 调用 gendoc 生成代码注释
1264
-
1265
- 调用 genreadme 生成 README
1266
-
1267
- 调用 genapi 生成 API 文档
1268
-
1269
- 输出文档清单
121
+ 配置文件中使用:
122
+ ```json
123
+ {
124
+ "mcpServers": {
125
+ "mcp-probe-kit": {
126
+ "command": "mcp-probe-kit"
127
+ }
128
+ }
129
+ }
1270
130
  ```
1271
131
 
1272
- **输出**:
1273
- - 带注释的代码
1274
- - README.md
1275
- - API 文档
1276
- - 文档清单
1277
-
1278
- ---
1279
-
1280
- ---
1281
-
1282
- ## 📚 文档
1283
-
1284
- - **[如何让 AI 正确调用工具](docs/HOW_TO_TRIGGER.md)** ⭐ 推荐阅读 - 实用的对话技巧
1285
- - **[最佳实践](docs/BEST_PRACTICES.md)** - 完整的工具调用指南和使用技巧
1286
- - **[工具列表](#功能特性)** - 所有工具的详细说明
1287
- - **[常见问题](#常见问题)** - FAQ
1288
-
1289
- ---
1290
-
1291
- ## 🎯 使用场景示例
1292
-
1293
- ### 🎤 Interview 模式(推荐)🆕
1294
-
1295
- #### 场景 1: 需求不明确时
1296
- ```
1297
- 用户: "我想做登录功能"
1298
-
1299
- AI: interview "登录功能"
1300
-
1301
- 生成 12-15 个结构化问题
1302
-
1303
- 用户: 回答所有问题
1304
-
1305
- AI: 生成 docs/interviews/user-login-interview.md
1306
-
1307
- 用户: "开始开发"
1308
-
1309
- AI: start_feature --from-interview user-login
1310
-
1311
- 生成完整的功能规格文档 + 工作量估算
1312
- ```
132
+ ### 重启客户端
1313
133
 
1314
- #### 场景 2: 分步进行
1315
- ```
1316
- 第1天:
1317
- 用户: "我想做登录功能"
1318
- AI: interview "登录功能"
1319
- 用户: [回答问题]
1320
- AI: 生成访谈记录
1321
-
1322
- 第3天:
1323
- 用户: "开始做登录功能"
1324
- AI: start_feature --from-interview user-login
1325
- AI: 读取之前的访谈,生成规格文档
1326
- ```
134
+ 配置完成后,**完全退出并重新打开**你的 MCP 客户端。
1327
135
 
1328
- #### 场景 3: AI 主动提问
1329
- ```
1330
- 用户: "优化这段代码"
1331
- AI: 发现不确定因素
1332
- AI: ask_user "优化目标是性能还是可读性?"
1333
- 用户: "性能"
1334
- AI: 继续优化
1335
- ```
136
+ **👉 [详细安装指南](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
1336
137
 
1337
138
  ---
1338
139
 
1339
- ### 📝 日常开发流程
1340
- ```
1341
- 1. code_review @feature.ts # 代码提交前审查
1342
- 2. gentest @feature.ts # 生成测试用例
1343
- 3. genapi @api/user.ts # 生成 API 文档
1344
- 4. gencommit # 提交代码
1345
- ```
1346
-
1347
- ### 🐛 调试流程
1348
- ```
1349
- 1. debug # 分析错误
1350
- 2. refactor @buggy-code.ts # 重构建议
1351
- 3. gentest @fixed-code.ts # 补充测试
1352
- 4. gencommit # 提交修复
1353
- ```
1354
-
1355
- ### 🚀 新项目启动
1356
- ```
1357
- 1. init_project @requirements.md # 初始化项目结构
1358
- 2. init_setting # 配置 AI
1359
- 3. check_deps # 检查依赖健康度
1360
- 4. 开始开发...
1361
- ```
1362
-
1363
- ### 🔍 接手老项目
1364
- ```
1365
- 1. analyze_project # 深度分析项目结构
1366
- 2. init_project_context # 生成项目上下文文档
1367
- 3. check_deps # 检查依赖健康度
1368
- 4. code_review # 代码质量审查
1369
- 5. 开始维护和开发...
1370
- ```
1371
-
1372
- ### 🎯 添加新功能(两种方式)
1373
-
1374
- #### 方式 1: Interview 模式(需求不明确时)🆕
1375
- ```
1376
- 1. interview "用户登录认证功能" # 访谈澄清需求
1377
- 2. 回答 12-15 个问题
1378
- 3. start_feature --from-interview user-auth # 基于访谈生成规格
1379
- 4. 根据 tasks.md 逐步实现
1380
- 5. gentest @feature.ts # 生成测试
1381
- 6. gencommit # 提交代码
1382
- ```
1383
-
1384
- #### 方式 2: 直接开发(需求明确时)
1385
- ```
1386
- 1. init_project_context # 确保项目上下文存在
1387
- 2. add_feature user-auth "用户登录认证功能" # 生成功能规格
1388
- 3. 根据 tasks.md 逐步实现
1389
- 4. gentest @feature.ts # 生成测试
1390
- 5. gencommit # 提交代码
1391
- ```
1392
-
1393
- ### 📦 版本发布
1394
- ```
1395
- 1. code_review # 全面代码审查
1396
- 2. genchangelog v1.2.0 # 生成 Changelog
1397
- 3. genpr # 生成 PR 描述
1398
- 4. 发布版本
1399
- ```
140
+ ## 使用示例
1400
141
 
1401
- ### 🔍 性能优化
1402
- ```
1403
- 1. perf @slow-function.ts # 性能分析
1404
- 2. refactor @slow-function.ts # 重构优化
1405
- 3. gentest @optimized.ts # 测试验证
1406
- 4. gencommit # 提交优化
142
+ ### 日常开发
143
+ ```bash
144
+ code_review @feature.ts # 代码审查
145
+ gentest @feature.ts # 生成测试
146
+ gencommit # 生成提交消息
1407
147
  ```
1408
148
 
1409
- ### 🚀 使用智能编排(推荐)
1410
-
1411
- #### 新功能开发
1412
- ```
1413
- start_feature user-auth "用户登录认证功能"
1414
- # 自动完成:检查上下文 → 生成规格 → 工作量估算
149
+ ### 新功能开发
150
+ ```bash
151
+ start_feature user-auth "用户认证功能"
152
+ # 自动完成:需求分析 → 设计方案 → 工作量估算
1415
153
  ```
1416
154
 
1417
- #### Bug 修复
1418
- ```
155
+ ### Bug 修复
156
+ ```bash
1419
157
  start_bugfix
1420
158
  # 然后粘贴错误信息
1421
- # 自动完成:分析修复测试 → 提交消息
1422
- ```
1423
-
1424
- #### 代码体检
1425
- ```
1426
- start_review @feature.ts
1427
- # 自动完成:质量审查 → 安全扫描 → 性能分析
1428
- ```
1429
-
1430
- #### 快速上手项目
1431
- ```
1432
- start_onboard
1433
- # 自动完成:项目分析 → 生成上下文文档
1434
- ```
1435
-
1436
- #### API 开发
1437
- ```
1438
- start_api @api/user.ts
1439
- # 自动完成:API 文档 → Mock 数据 → 测试代码
1440
- ```
1441
-
1442
- #### 发布准备
1443
- ```
1444
- start_release v1.2.0
1445
- # 自动完成:Changelog → PR 描述 → 发布清单
1446
- ```
1447
-
1448
- ---
1449
-
1450
- ## 🛠️ 开发指南
1451
-
1452
- ### 项目结构
1453
- ```
1454
- mcp-probe-kit/
1455
- ├── src/
1456
- │ ├── index.ts # MCP 服务器主入口
1457
- │ └── tools/ # 工具实现(38 个)
1458
- │ ├── index.ts # 工具导出
1459
- │ ├── detect_shell.ts # 套壳检测
1460
- │ ├── code_review.ts # 代码审查
1461
- │ ├── security_scan.ts # 安全扫描 🆕
1462
- │ ├── debug.ts # 调试助手
1463
- │ ├── gentest.ts # 测试生成
1464
- │ ├── refactor.ts # 重构建议
1465
- │ ├── perf.ts # 性能分析
1466
- │ ├── fix.ts # 自动修复
1467
- │ ├── gencommit.ts # 提交生成
1468
- │ ├── genapi.ts # 文档生成
1469
- │ ├── gendoc.ts # 注释生成
1470
- │ ├── genpr.ts # PR 生成
1471
- │ ├── genchangelog.ts # Changelog 生成
1472
- │ ├── gensql.ts # SQL 生成器
1473
- │ ├── genui.ts # UI 组件生成器
1474
- │ ├── gen_mock.ts # Mock 数据生成 🆕
1475
- │ ├── design2code.ts # 设计稿转代码 🆕
1476
- │ ├── explain.ts # 代码解释器
1477
- │ ├── convert.ts # 代码转换器
1478
- │ ├── css_order.ts # CSS 顺序规范
1479
- │ ├── genreadme.ts # README 生成器
1480
- │ ├── split.ts # 文件拆分工具
1481
- │ ├── fix_bug.ts # Bug 修复流程 🆕
1482
- │ ├── estimate.ts # 工作量估算 🆕
1483
- │ ├── init_setting.ts # 配置初始化
1484
- │ ├── init_project.ts # 项目初始化
1485
- │ ├── check_deps.ts # 依赖检查
1486
- │ ├── resolve_conflict.ts # Git 冲突解决
1487
- │ ├── analyze_project.ts # 项目分析
1488
- │ ├── init_project_context.ts # 项目上下文初始化
1489
- │ ├── add_feature.ts # 添加新功能
1490
- │ ├── start_feature.ts # 智能编排:新功能开发 🆕
1491
- │ ├── start_bugfix.ts # 智能编排:Bug 修复 🆕
1492
- │ ├── start_review.ts # 智能编排:代码体检 🆕
1493
- │ ├── start_release.ts # 智能编排:发布准备 🆕
1494
- │ ├── start_refactor.ts # 智能编排:代码重构 🆕
1495
- │ ├── start_onboard.ts # 智能编排:快速上手 🆕
1496
- │ ├── start_api.ts # 智能编排:API 开发 🆕
1497
- │ └── start_doc.ts # 智能编排:文档生成 🆕
1498
- ├── build/ # 编译输出
1499
- ├── package.json
1500
- ├── tsconfig.json
1501
- └── README.md
1502
- ```
1503
-
1504
- ### 添加新工具
1505
-
1506
- 1. **创建工具文件**:`src/tools/your_tool.ts`
1507
- ```typescript
1508
- export async function yourTool(args: any) {
1509
- try {
1510
- const message = `你的指令内容...`;
1511
- return {
1512
- content: [{ type: "text", text: message }],
1513
- };
1514
- } catch (error) {
1515
- return {
1516
- content: [{ type: "text", text: `❌ 错误: ${error}` }],
1517
- isError: true,
1518
- };
1519
- }
1520
- }
1521
- ```
1522
-
1523
- 2. **导出工具**:在 `src/tools/index.ts` 中添加
1524
- ```typescript
1525
- export { yourTool } from "./your_tool.js";
1526
- ```
1527
-
1528
- 3. **注册工具**:在 `src/index.ts` 中添加工具定义和处理
1529
-
1530
- 4. **重新构建**:
1531
- ```bash
1532
- npm run build
159
+ # 自动完成:问题定位修复方案测试代码
1533
160
  ```
1534
161
 
1535
- ### 开发命令
1536
-
162
+ ### UI 开发
1537
163
  ```bash
1538
- # 安装依赖
1539
- npm install
1540
-
1541
- # 编译
1542
- npm run build
1543
-
1544
- # 监听模式(开发时使用)
1545
- npm run watch
1546
-
1547
- # 测试服务器
1548
- npm run dev
164
+ start_ui "登录页面" --mode=auto
165
+ # 自动完成:设计系统 → 组件生成 → 代码输出
1549
166
  ```
1550
167
 
1551
- ---
1552
-
1553
- ## 🔧 配置说明
1554
-
1555
- ### MCP 服务器配置
1556
-
1557
- 配置文件位置(根据你的 MCP 客户端):
1558
- - **Cursor**: `cline_mcp_settings.json`
1559
- - **Claude Desktop**: `claude_desktop_config.json`
1560
-
1561
- ### 工具参数说明
1562
-
1563
- 所有工具的参数都是**可选的**,AI 会自动推断。常用参数:
1564
-
1565
- | 工具 | 参数 | 说明 |
1566
- |------|------|------|
1567
- | detect_shell | nonce | 自定义 nonce 字符串 |
1568
- | code_review | focus | quality/security/performance/all |
1569
- | gentest | framework | jest/vitest/mocha |
1570
- | genapi | format | markdown/openapi/jsdoc |
1571
- | gendoc | style, lang | jsdoc/tsdoc, zh/en |
1572
- | genchangelog | version | 版本号(如 v1.2.0) |
1573
- | init_project | input | 项目需求描述 |
1574
- | perf | type | algorithm/memory/react/database |
168
+ **👉 [更多使用示例](https://mcp-probe-kit.bytezonex.com/pages/examples.html)**
1575
169
 
1576
170
  ---
1577
171
 
@@ -1579,7 +173,7 @@ npm run dev
1579
173
 
1580
174
  ### Q1: 工具无法使用或报错怎么办?
1581
175
 
1582
- 如果遇到安装或运行问题,可以通过以下方式输出详细日志进行排查:
176
+ 查看详细日志:
1583
177
 
1584
178
  **Windows (PowerShell):**
1585
179
  ```powershell
@@ -1591,60 +185,24 @@ npx -y mcp-probe-kit@latest 2>&1 | Tee-Object -FilePath .\mcp-probe-kit.log
1591
185
  npx -y mcp-probe-kit@latest 2>&1 | tee ./mcp-probe-kit.log
1592
186
  ```
1593
187
 
1594
- 这会将错误信息保存到 `mcp-probe-kit.log` 文件中,方便排查问题或提交 Issue。
1595
-
1596
188
  ### Q2: 配置后客户端无法识别工具?
1597
189
 
1598
190
  1. **重启客户端**(完全退出后重新打开)
1599
- 2. 检查配置文件路径是否正确:
1600
- - **Cursor/Cline**: 查看上方配置路径
1601
- - **Claude Desktop**: `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
1602
- - **Continue**: `~/.continue/config.json`
191
+ 2. 检查配置文件路径是否正确
1603
192
  3. 确认 JSON 格式正确,没有语法错误
1604
193
  4. 查看客户端的开发者工具或日志中的错误信息
1605
194
 
1606
- ### Q3: npx 方式每次都很慢?
1607
-
1608
- 建议全局安装以提升速度:
1609
- ```bash
1610
- npm install -g mcp-probe-kit
1611
- ```
1612
-
1613
- 然后修改配置为:
1614
- ```json
1615
- {
1616
- "mcpServers": {
1617
- "mcp-probe-kit": {
1618
- "command": "mcp-probe-kit"
1619
- }
1620
- }
1621
- }
1622
- ```
1623
-
1624
- ### Q4: 工具生成的内容不符合预期?
1625
-
1626
- 所有工具都是**指令生成器**,生成的是给 AI 的指令:
1627
- - AI 会根据指令理解你的需求
1628
- - 可以在对话中进一步说明具体要求
1629
- - 例如:"用 React Hooks 实现"、"添加 TypeScript 类型"等
1630
-
1631
- ### Q5: 如何更新到最新版本?
195
+ ### Q3: 如何更新到最新版本?
1632
196
 
1633
197
  **npx 方式(推荐):**
1634
- 配置中使用 `@latest` 标签,会自动使用最新版本:
1635
- ```json
1636
- "args": ["mcp-probe-kit@latest"]
1637
- ```
198
+ 配置中使用 `@latest` 标签,会自动使用最新版本。
1638
199
 
1639
200
  **全局安装方式:**
1640
201
  ```bash
1641
202
  npm update -g mcp-probe-kit
1642
203
  ```
1643
204
 
1644
- **查看当前版本:**
1645
- ```bash
1646
- npm list -g mcp-probe-kit
1647
- ```
205
+ **👉 [更多常见问题](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
1648
206
 
1649
207
  ---
1650
208
 
@@ -1658,12 +216,6 @@ npm list -g mcp-probe-kit
1658
216
  - 改进文档和示例
1659
217
  - 修复 Bug
1660
218
 
1661
- **开发规范:**
1662
- - 遵循 TypeScript 规范
1663
- - 工具命名简洁(建议 10 字符以内)
1664
- - 提供清晰的使用说明和示例
1665
- - 保持"指令生成器"模式(不直接操作文件系统)
1666
-
1667
219
  ---
1668
220
 
1669
221
  ## 📄 License
@@ -1674,94 +226,13 @@ MIT License
1674
226
 
1675
227
  ## 🔗 相关链接
1676
228
 
229
+ - **作者**: [小墨 (Kyle)](https://www.bytezonex.com/)
230
+ - **GitHub**: [mcp-probe-kit](https://github.com/mybolide/mcp-probe-kit)
231
+ - **npm**: [mcp-probe-kit](https://www.npmjs.com/package/mcp-probe-kit)
232
+ - **文档**: [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)
1677
233
  - [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)
1678
234
  - [GitHub Spec-Kit](https://github.com/github/spec-kit)
1679
- - [Conventional Commits](https://www.conventionalcommits.org/)
1680
- - [OpenAPI Specification](https://swagger.io/specification/)
1681
-
1682
- ---
1683
-
1684
- ## 💡 设计理念
1685
-
1686
- ### 指令生成器模式
1687
-
1688
- 所有工具都采用**指令生成器模式**:
1689
- - 工具不直接操作文件系统或执行命令
1690
- - 而是生成清晰的指令告诉 AI 需要做什么
1691
- - AI 理解指令后,使用 Cursor 的能力完成实际操作
1692
-
1693
- **优势:**
1694
- - ✅ 代码简洁,易于维护
1695
- - ✅ AI 可以智能处理边界情况
1696
- - ✅ 用户可见操作过程,更透明
1697
- - ✅ 灵活性强,AI 可以根据实际情况调整
1698
-
1699
- ### 为什么叫 Probe Kit?
1700
-
1701
- - **Probe(探针)**:探测代码质量、性能瓶颈、依赖健康度
1702
- - **Kit(工具集)**:24 个工具覆盖开发全流程
1703
-
1704
- ### 工具分类
1705
-
1706
- ```
1707
- 代码质量 (8)
1708
- ├── detect_shell 套壳检测
1709
- ├── code_review 代码审查
1710
- ├── security_scan 安全扫描 🆕
1711
- ├── debug 调试助手
1712
- ├── gentest 测试生成
1713
- ├── refactor 重构建议
1714
- ├── perf 性能分析
1715
- └── fix 自动修复
1716
-
1717
- 开发效率 (15)
1718
- ├── gencommit 提交生成
1719
- ├── genapi 文档生成
1720
- ├── gendoc 注释生成
1721
- ├── genpr PR 生成
1722
- ├── genchangelog Changelog 生成
1723
- ├── gensql SQL 生成器
1724
- ├── genui UI 组件生成器
1725
- ├── gen_mock Mock 数据生成 🆕
1726
- ├── design2code 设计稿转代码 🆕
1727
- ├── explain 代码解释器
1728
- ├── convert 代码转换器
1729
- ├── css_order CSS 顺序规范
1730
- ├── genreadme README 生成器
1731
- ├── split 文件拆分工具
1732
- ├── fix_bug Bug 修复流程 🆕
1733
- └── estimate 工作量估算 🆕
1734
-
1735
- 项目管理 (8)
1736
- ├── init_setting 配置初始化
1737
- ├── init_project 项目初始化
1738
- ├── check_deps 依赖检查
1739
- ├── resolve_conflict Git 冲突解决
1740
- ├── analyze_project 项目分析工具
1741
- ├── init_project_context 项目上下文初始化
1742
- ├── add_feature 添加新功能
1743
- └── start_onboard 快速上手(编排)🆕
1744
-
1745
- 智能编排 (8)
1746
- ├── start_feature 新功能开发 🆕
1747
- ├── start_bugfix Bug 修复 🆕
1748
- ├── start_review 代码体检 🆕
1749
- ├── start_release 发布准备 🆕
1750
- ├── start_refactor 代码重构 🆕
1751
- ├── start_onboard 快速上手 🆕
1752
- ├── start_api API 开发 🆕
1753
- └── start_doc 文档生成 🆕
1754
- ```
1755
-
1756
- ---
1757
-
1758
- ## 👨‍💻 作者
1759
-
1760
- **小墨 (Kyle)**
1761
-
1762
- - 🌐 Website: [bytezonex.com](https://www.bytezonex.com/)
1763
- - 💼 专注于 AI 辅助开发工具
1764
235
 
1765
236
  ---
1766
237
 
1767
- **Made with ❤️ for Cursor Users**
238
+ **Made with ❤️ for AI-Powered Development**