mcp-probe-kit 3.0.3 → 3.0.6

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 (60) hide show
  1. package/README.md +457 -423
  2. package/build/index.js +434 -140
  3. package/build/lib/template-loader.js +317 -317
  4. package/build/lib/tool-execution-context.d.ts +8 -0
  5. package/build/lib/tool-execution-context.js +20 -0
  6. package/build/schemas/git-tools.js +16 -16
  7. package/build/tools/__tests__/start_bugfix.unit.test.js +14 -14
  8. package/build/tools/__tests__/start_ui.unit.test.js +11 -11
  9. package/build/tools/add_feature.js +79 -79
  10. package/build/tools/ask_user.js +5 -5
  11. package/build/tools/interview.js +9 -9
  12. package/build/tools/start_bugfix.d.ts +2 -1
  13. package/build/tools/start_bugfix.js +131 -122
  14. package/build/tools/start_feature.d.ts +2 -1
  15. package/build/tools/start_feature.js +113 -104
  16. package/build/tools/start_onboard.d.ts +2 -1
  17. package/build/tools/start_onboard.js +57 -51
  18. package/build/tools/start_product.d.ts +2 -1
  19. package/build/tools/start_product.js +9 -1
  20. package/build/tools/start_ralph.d.ts +2 -1
  21. package/build/tools/start_ralph.js +9 -3
  22. package/build/tools/start_ui.d.ts +2 -1
  23. package/build/tools/start_ui.js +102 -88
  24. package/build/tools/ui-ux-tools.d.ts +2 -1
  25. package/build/tools/ui-ux-tools.js +19 -3
  26. package/build/utils/ui-sync.d.ts +6 -2
  27. package/build/utils/ui-sync.js +125 -29
  28. package/docs/assets/font/MaterialSymbolsOutlined.codepoints +4102 -0
  29. package/docs/assets/font/MaterialSymbolsOutlined.ttf +0 -0
  30. package/docs/assets/font/noto-sans-sc-400.ttf +0 -0
  31. package/docs/assets/font/noto-sans-sc-700.ttf +0 -0
  32. package/docs/assets/font/noto-sans-sc-900.ttf +0 -0
  33. package/docs/assets/js/i18n.js +375 -0
  34. package/docs/assets/js/tailwind.js +83 -83
  35. package/docs/assets/logo-zh.png +0 -0
  36. package/docs/assets/logo.png +0 -0
  37. package/docs/data/tools.js +21 -21
  38. package/docs/debug-i18n.html +163 -0
  39. package/docs/i18n/all-tools/en.json +157 -0
  40. package/docs/i18n/all-tools/ja.json +157 -0
  41. package/docs/i18n/all-tools/ko.json +157 -0
  42. package/docs/i18n/all-tools/zh-CN.json +157 -0
  43. package/docs/i18n/en.json +518 -0
  44. package/docs/i18n/ja.json +518 -0
  45. package/docs/i18n/ko.json +518 -0
  46. package/docs/i18n/zh-CN.json +518 -0
  47. package/docs/index.html +43 -32
  48. package/docs/pages/all-tools.html +514 -330
  49. package/docs/pages/examples.html +689 -673
  50. package/docs/pages/getting-started.html +589 -577
  51. package/docs/pages/migration.html +298 -283
  52. package/package.json +6 -6
  53. package/docs/project-context/architecture.md +0 -0
  54. package/docs/project-context/how-to-develop.md +0 -313
  55. package/docs/project-context/how-to-test.md +0 -457
  56. package/docs/project-context/tech-stack.md +0 -96
  57. package/docs/project-context.md +0 -53
  58. package/docs/specs/git-work-report/design.md +0 -568
  59. package/docs/specs/git-work-report/requirements.md +0 -131
  60. package/docs/specs/git-work-report/tasks.md +0 -197
package/README.md CHANGED
@@ -1,423 +1,457 @@
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.xv3.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**
1
+ <div align="center">
2
+ <img src="docs/assets/logo.png" alt="知时MCP Logo" width="160"/>
3
+ <h1>知时MCP | mcp-probe-kit</h1>
4
+ <p><strong>Know the Context, Feed the Moment.</strong></p>
5
+ <p>
6
+ <code>Introspection</code> · <code>Context Hydration</code> · <code>Delegated Orchestration</code>
7
+ </p>
8
+ </div>
9
+
10
+ ---
11
+
12
+ <!-- mcp-name: io.github.mybolide/mcp-probe-kit -->
13
+
14
+ > **Talk is cheap, show me the Context.**
15
+ >
16
+ > mcp-probe-kit is a protocol-level toolkit designed for developers who want AI to truly understand their project's intent. It's not just a collection of 21 tools—it's a context-aware system that helps AI agents grasp what you're building.
17
+
18
+ **Languages**: [English](README.md) | [简体中文](i18n/README.zh-CN.md) | [日本語](i18n/README.ja-JP.md) | [한국어](i18n/README.ko-KR.md) | [Español](i18n/README.es-ES.md) | [Français](i18n/README.fr-FR.md) | [Deutsch](i18n/README.de-DE.md) | [Português (BR)](i18n/README.pt-BR.md)
19
+
20
+ [![npm version](https://img.shields.io/npm/v/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
21
+ [![npm downloads](https://img.shields.io/npm/dm/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
22
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
23
+ [![GitHub stars](https://img.shields.io/github/stars/mybolide/mcp-probe-kit.svg)](https://github.com/mybolide/mcp-probe-kit/stargazers)
24
+
25
+ > 🚀 AI-Powered Complete Development Toolkit - Covering the Entire Development Lifecycle
26
+
27
+ A powerful MCP (Model Context Protocol) server providing **21 tools** covering the complete workflow from product analysis to final release (Requirements Design → Development → Quality → Release), all tools support **structured output**.
28
+
29
+ **🎉 v3.0 Major Update**: Streamlined tool count, focus on core competencies, eliminate choice paralysis, let AI do more native work
30
+
31
+ **Supports All MCP Clients**: Cursor, Claude Desktop, Cline, Continue, and more
32
+
33
+ **Protocol Version**: MCP 2025-11-25 · **SDK**: @modelcontextprotocol/sdk 1.27.1
34
+
35
+ ---
36
+
37
+ ## 📚 Complete Documentation
38
+
39
+ **👉 [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)**
40
+
41
+ - [Quick Start](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html) - Setup in 5 minutes
42
+ - [All Tools](https://mcp-probe-kit.bytezonex.com/pages/all-tools.html) - Complete list of 21 tools
43
+ - [Best Practices](https://mcp-probe-kit.bytezonex.com/pages/examples.html) - Full development workflow guide
44
+ - [v3.0 Migration Guide](https://mcp-probe-kit.bytezonex.com/pages/migration.html) - Upgrade from v2.x to v3.0
45
+
46
+ ---
47
+
48
+ ## Core Features
49
+
50
+ ### 📦 21 Tools
51
+
52
+ - **🔄 Workflow Orchestration** (6 tools) - One-click complex development workflows
53
+ - `start_feature`, `start_bugfix`, `start_onboard`, `start_ui`, `start_product`, `start_ralph`
54
+ - **🔍 Code Analysis** (3 tools) - Code quality and refactoring
55
+ - `code_review`, `fix_bug`, `refactor`
56
+ - **📝 Git Tools** (2 tools) - Git commits and work reports
57
+ - `gencommit`, `git_work_report`
58
+ - **⚡ Code Generation** (1 tool) - Test generation
59
+ - `gentest`
60
+ - **📦 Project Management** (7 tools) - Project initialization and requirements management
61
+ - `init_project`, `init_project_context`, `add_feature`, `estimate`, `interview`, `ask_user`
62
+ - **🎨 UI/UX Tools** (3 tools) - Design systems and data synchronization
63
+ - `ui_design_system`, `ui_search`, `sync_ui_data`
64
+
65
+ ### 🎯 Structured Output
66
+
67
+ Core and orchestration tools support **structured output**, returning machine-readable JSON data, improving AI parsing accuracy, supporting tool chaining and state tracking.
68
+
69
+ ### ⏱️ Native Tasks, Progress, and Cancellation
70
+
71
+ - Built on MCP SDK native task support (`taskStore` + `taskMessageQueue`)
72
+ - Supports task lifecycle endpoints: `tasks/get`, `tasks/result`, `tasks/list`, `tasks/cancel`
73
+ - Advertises `capabilities.tasks.requests.tools.call` so clients can create tasks for `tools/call`
74
+ - Emits `notifications/progress` when client provides `_meta.progressToken`
75
+ - Handles request cancellation via `AbortSignal` and returns a clear cancellation error
76
+ - Long-running orchestration tools (`start_*`) and `sync_ui_data` support cooperative cancellation/progress callbacks
77
+
78
+ ### 🔌 Extensions & UI Apps (Optional)
79
+
80
+ - Trace metadata passthrough: request `_meta.trace` is preserved in tool responses (`_meta.trace`)
81
+ - Optional extensions capability switch: enable with `MCP_ENABLE_EXTENSIONS_CAPABILITY=1`
82
+ - Optional MCP Apps resource output for UI tools: enable with `MCP_ENABLE_UI_APPS=1`
83
+ - UI tools can expose preview resources via `ui://...` and response `_meta.ui.resourceUri`
84
+
85
+ ### 🧭 Delegated Orchestration Protocol
86
+
87
+ All `start_*` orchestration tools return an **execution plan** in `structuredContent.metadata.plan`.
88
+ AI needs to **call tools step by step and persist files**, rather than the tool executing internally.
89
+
90
+ **Plan Schema (Core Fields)**:
91
+ ```json
92
+ {
93
+ "mode": "delegated",
94
+ "steps": [
95
+ {
96
+ "id": "spec",
97
+ "tool": "add_feature",
98
+ "args": { "feature_name": "user-auth", "description": "User authentication feature" },
99
+ "outputs": ["docs/specs/user-auth/requirements.md"]
100
+ }
101
+ ]
102
+ }
103
+ ```
104
+
105
+ **Field Description**:
106
+ - `mode`: Fixed as `delegated`
107
+ - `steps`: Array of execution steps
108
+ - `tool`: Tool name (e.g. `add_feature`)
109
+ - `action`: Manual action description when no tool (e.g. `update_project_context`)
110
+ - `args`: Tool parameters
111
+ - `outputs`: Expected artifacts
112
+ - `when/dependsOn/note`: Optional conditions and notes
113
+
114
+ ### 🧩 Structured Output Field Specification (Key Fields)
115
+
116
+ Both orchestration and atomic tools return `structuredContent`, common fields:
117
+ - `summary`: One-line summary
118
+ - `status`: Status (pending/success/failed/partial)
119
+ - `steps`: Execution steps (orchestration tools)
120
+ - `artifacts`: Artifact list (path + purpose)
121
+ - `metadata.plan`: Delegated execution plan (only start_*)
122
+ - `specArtifacts`: Specification artifacts (start_feature)
123
+ - `estimate`: Estimation results (start_feature / estimate)
124
+
125
+ ### 🧠 Requirements Clarification Mode (Requirements Loop)
126
+
127
+ When requirements are unclear, use `requirements_mode=loop` in `start_feature / start_bugfix / start_ui`.
128
+ This mode performs 1-2 rounds of structured clarification before entering spec/fix/UI execution.
129
+
130
+ **Example:**
131
+ ```json
132
+ {
133
+ "feature_name": "user-auth",
134
+ "description": "User authentication feature",
135
+ "requirements_mode": "loop",
136
+ "loop_max_rounds": 2,
137
+ "loop_question_budget": 5
138
+ }
139
+ ```
140
+
141
+ ### 🧩 Template System (Regular Model Friendly)
142
+
143
+ `add_feature` supports template profiles, default `auto` auto-selects: prefers `guided` when requirements are incomplete (includes detailed filling rules and checklists), selects `strict` when requirements are complete (more compact structure, suitable for high-capability models or archival scenarios).
144
+
145
+ **Example:**
146
+ ```json
147
+ {
148
+ "description": "Add user authentication feature",
149
+ "template_profile": "auto"
150
+ }
151
+ ```
152
+
153
+ **Applicable Tools**:
154
+ - `start_feature` passes `template_profile` to `add_feature`
155
+ - `start_bugfix` / `start_ui` also support `template_profile` for controlling guidance strength (auto/guided/strict)
156
+
157
+ **Template Profile Strategy**:
158
+ - `guided`: Less/incomplete requirements info, regular model priority
159
+ - `strict`: Requirements structured, prefer more compact guidance
160
+ - `auto`: Default recommendation, auto-selects guided/strict
161
+
162
+ ### 🔄 Workflow Orchestration
163
+
164
+ 6 intelligent orchestration tools that automatically combine multiple basic tools for one-click complex development workflows:
165
+ - `start_feature` - New feature development (Requirements Design → Estimation)
166
+ - `start_bugfix` - Bug fixing (Analysis Fix → Testing)
167
+ - `start_onboard` - Project onboarding (Generate project context docs)
168
+ - `start_ui` - UI development (Design system → Components → Code)
169
+ - `start_product` - Product design (PRD → Prototype → Design system → HTML)
170
+ - `start_ralph` - Ralph Loop (Iterative development until goal completion)
171
+
172
+ ### 🚀 Product Design Workflow
173
+
174
+ `start_product` is a complete product design orchestration tool, from requirements to interactive prototype:
175
+
176
+ **Workflow:**
177
+ 1. **Requirements Analysis** - Generate standard PRD (product overview, feature requirements, page list)
178
+ 2. **Prototype Design** - Generate detailed prototype docs for each page
179
+ 3. **Design System** - Generate design specifications based on product type
180
+ 4. **HTML Prototype** - Generate interactive prototype viewable in browser
181
+ 5. **Project Context** - Auto-update project documentation
182
+
183
+ **Structured Output Additions**:
184
+ - `start_product.structuredContent.artifacts`: Artifact list (PRD, prototypes, design system, etc.)
185
+ - `interview.structuredContent.mode`: `usage` / `questions` / `record`
186
+
187
+ ### 🎨 UI/UX Pro Max
188
+
189
+ 3 UI/UX tools with `start_ui` as the unified entry point:
190
+ - `start_ui` - One-click UI development (supports intelligent mode) (orchestration tool)
191
+ - `ui_design_system` - Intelligent design system generation
192
+ - `ui_search` - UI/UX data search (BM25 algorithm)
193
+ - `sync_ui_data` - Sync latest UI/UX data locally
194
+
195
+ **Note**: `start_ui` automatically calls `ui_design_system` and `ui_search`, you don't need to call them separately.
196
+
197
+ **Inspiration:**
198
+ - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX design system philosophy
199
+ - [json-render](https://github.com/vercel-labs/json-render) - JSON template rendering engine
200
+
201
+ **Why use `sync_ui_data`?**
202
+
203
+ Our `start_ui` tool relies on a rich UI/UX database (colors, icons, charts, components, design patterns, etc.) to generate high-quality design systems and code. This data comes from npm package [uipro-cli](https://www.npmjs.com/package/uipro-cli), including:
204
+ - 🎨 Color schemes (mainstream brand colors, color palettes)
205
+ - 🔣 Icon libraries (React Icons, Heroicons, etc.)
206
+ - 📊 Chart components (Recharts, Chart.js, etc.)
207
+ - 🎯 Landing page templates (SaaS, e-commerce, government, etc.)
208
+ - 📐 Design specifications (spacing, fonts, shadows, etc.)
209
+
210
+ **Data Sync Strategy:**
211
+ 1. **Embedded Data**: Synced at build time, works offline
212
+ 2. **Cached Data**: Runtime updates to `~/.mcp-probe-kit/ui-ux-data/`
213
+ 3. **Manual Sync**: Use `sync_ui_data` to force update latest data
214
+
215
+ This ensures `start_ui` can generate professional-grade UI code even offline.
216
+
217
+ ### 🎤 Requirements Interview
218
+
219
+ 2 interview tools to clarify requirements before development:
220
+ - `interview` - Structured requirements interview
221
+ - `ask_user` - AI proactive questioning
222
+
223
+ ---
224
+
225
+ ## 🧭 Tool Selection Guide
226
+
227
+ ### When to use orchestration tools vs individual tools?
228
+
229
+ **Use orchestration tools (start_*) when:**
230
+ - ✅ Need complete workflow (multiple steps)
231
+ - Want to automate multiple tasks
232
+ - Need to generate multiple artifacts (docs, code, tests, etc.)
233
+
234
+ **Use individual tools when:**
235
+ - ✅ Only need specific functionality
236
+ - ✅ Already have project context docs
237
+ - ✅ Need more fine-grained control
238
+
239
+ ### Common Scenario Selection
240
+
241
+ | Scenario | Recommended Tool | Reason |
242
+ |---------|-----------------|--------|
243
+ | Develop new feature (complete flow) | `start_feature` | Auto-complete: spec→estimation |
244
+ | Only need feature spec docs | `add_feature` | More lightweight, only generates docs |
245
+ | Fix bug (complete flow) | `start_bugfix` | Auto-complete: analysis→fix→test |
246
+ | Only need bug analysis | `fix_bug` | Faster, only analyzes problem |
247
+ | Generate design system | `ui_design_system` | Directly generate design specs |
248
+ | Develop UI components | `start_ui` | Complete flow: design→components→code |
249
+ | Product design (requirements to prototype) | `start_product` | One-click: PRD→prototype→HTML |
250
+ | One-sentence requirement analysis | `init_project` | Generate complete project spec docs |
251
+ | Project onboarding docs | `init_project_context` | Generate tech stack/architecture/conventions |
252
+
253
+ ---
254
+
255
+ ## 🚀 Quick Start
256
+
257
+ ### Method 1: Use directly with npx (Recommended)
258
+
259
+ No installation needed, use the latest version directly.
260
+
261
+ #### Cursor / Cline Configuration
262
+
263
+ **Config file location:**
264
+ - Windows: `%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`
265
+ - macOS: `~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
266
+ - Linux: `~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
267
+
268
+ **Config content:**
269
+ ```json
270
+ {
271
+ "mcpServers": {
272
+ "mcp-probe-kit": {
273
+ "command": "npx",
274
+ "args": ["mcp-probe-kit@latest"]
275
+ }
276
+ }
277
+ }
278
+ ```
279
+
280
+ #### Claude Desktop Configuration
281
+
282
+ **Config file location:**
283
+ - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
284
+ - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
285
+ - Linux: `~/.config/Claude/claude_desktop_config.json`
286
+
287
+ **Config content:**
288
+ ```json
289
+ {
290
+ "mcpServers": {
291
+ "mcp-probe-kit": {
292
+ "command": "npx",
293
+ "args": ["-y", "mcp-probe-kit@latest"]
294
+ }
295
+ }
296
+ }
297
+ ```
298
+
299
+ ### Method 2: Global Installation
300
+
301
+ ```bash
302
+ npm install -g mcp-probe-kit
303
+ ```
304
+
305
+ Use in config file:
306
+ ```json
307
+ {
308
+ "mcpServers": {
309
+ "mcp-probe-kit": {
310
+ "command": "mcp-probe-kit"
311
+ }
312
+ }
313
+ }
314
+ ```
315
+
316
+ ### Restart Client
317
+
318
+ After configuration, **completely quit and reopen** your MCP client.
319
+
320
+ **👉 [Detailed Installation Guide](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
321
+
322
+ ---
323
+
324
+ ## 💡 Usage Examples
325
+
326
+ ### Daily Development
327
+ ```bash
328
+ code_review @feature.ts # Code review
329
+ gentest @feature.ts # Generate tests
330
+ gencommit # Generate commit message
331
+ ```
332
+
333
+ ### New Feature Development
334
+ ```bash
335
+ start_feature user-auth "User authentication feature"
336
+ # Auto-complete: Requirements analysis → Design → Effort estimation
337
+ ```
338
+
339
+ ### Bug Fixing
340
+ ```bash
341
+ start_bugfix
342
+ # Then paste error message
343
+ # Auto-complete: Problem location → Fix solution → Test code
344
+ ```
345
+
346
+ ### Product Design
347
+ ```bash
348
+ start_product "Online Education Platform" --product_type=SaaS
349
+ # Auto-complete: PRD → Prototype → Design system → HTML prototype
350
+ ```
351
+
352
+ ### UI Development
353
+ ```bash
354
+ start_ui "Login Page" --mode=auto
355
+ # Auto-complete: Design system → Component generation → Code output
356
+ ```
357
+
358
+ ### Project Context Documentation
359
+ ```bash
360
+ # Single file mode (default) - Generate a complete project-context.md
361
+ init_project_context
362
+
363
+ # Modular mode - Generate 6 category docs (suitable for large projects)
364
+ init_project_context --mode=modular
365
+ # Generates: project-context.md (index) + 5 category docs
366
+ ```
367
+
368
+ ### Git Work Report
369
+ ```bash
370
+ # Generate daily report
371
+ git_work_report --date 2026-02-03
372
+
373
+ # Generate weekly report
374
+ git_work_report --start_date 2026-02-01 --end_date 2026-02-07
375
+
376
+ # Save to file
377
+ git_work_report --date 2026-02-03 --output_file daily-report.md
378
+ # Auto-analyze Git diff, generate concise professional report
379
+ # If direct command fails, auto-provides temp script solution (auto-deletes after execution)
380
+ ```
381
+
382
+ **👉 [More Usage Examples](https://mcp-probe-kit.bytezonex.com/pages/examples.html)**
383
+
384
+ ---
385
+
386
+ ## ❓ FAQ
387
+
388
+ ### Q1: Tool not working or errors?
389
+
390
+ Check detailed logs:
391
+
392
+ **Windows (PowerShell):**
393
+ ```powershell
394
+ npx -y mcp-probe-kit@latest 2>&1 | Tee-Object -FilePath .\mcp-probe-kit.log
395
+ ```
396
+
397
+ **macOS/Linux:**
398
+ ```bash
399
+ npx -y mcp-probe-kit@latest 2>&1 | tee ./mcp-probe-kit.log
400
+ ```
401
+
402
+ ### Q2: Client not recognizing tools after configuration?
403
+
404
+ 1. **Restart client** (completely quit then reopen)
405
+ 2. Check config file path is correct
406
+ 3. Confirm JSON format is correct, no syntax errors
407
+ 4. Check client developer tools or logs for error messages
408
+
409
+ ### Q3: How to update to latest version?
410
+
411
+ **npx method (Recommended):**
412
+ Use `@latest` tag in config, automatically uses latest version.
413
+
414
+ **Global installation method:**
415
+ ```bash
416
+ npm update -g mcp-probe-kit
417
+ ```
418
+
419
+ **👉 [More FAQ](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
420
+
421
+ ---
422
+
423
+ ## 🤝 Contributing
424
+
425
+ Issues and Pull Requests welcome!
426
+
427
+ **Improvement suggestions:**
428
+ - Add useful tools
429
+ - Optimize existing tool prompts
430
+ - Improve documentation and examples
431
+ - Fix bugs
432
+
433
+ ---
434
+
435
+ ## 📄 License
436
+
437
+ MIT License
438
+
439
+ ---
440
+
441
+ ## 🔗 Related Links
442
+
443
+ - **Author**: [Kyle (小墨)](https://www.bytezonex.com/)
444
+ - **GitHub**: [mcp-probe-kit](https://github.com/mybolide/mcp-probe-kit)
445
+ - **npm**: [mcp-probe-kit](https://www.npmjs.com/package/mcp-probe-kit)
446
+ - **Documentation**: [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)
447
+
448
+ **Related Projects:**
449
+ - [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) - Official MCP protocol docs
450
+ - [GitHub Spec-Kit](https://github.com/github/spec-kit) - GitHub spec-driven development toolkit
451
+ - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX design system philosophy source
452
+ - [json-render](https://github.com/vercel-labs/json-render) - JSON template rendering engine inspiration
453
+ - [uipro-cli](https://www.npmjs.com/package/uipro-cli) - UI/UX data source
454
+
455
+ ---
456
+
457
+ **Made with ❤️ for AI-Powered Development**