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