mcp-probe-kit 3.0.24 → 3.1.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 (130) hide show
  1. package/README.md +755 -779
  2. package/build/index.js +38 -40
  3. package/build/lib/agents-md-template.js +32 -32
  4. package/build/lib/skill-bridge.js +12 -12
  5. package/build/resources/index.d.ts +4 -0
  6. package/build/resources/index.js +4 -0
  7. package/build/resources/tool-params-guide.d.ts +571 -0
  8. package/build/resources/tool-params-guide.js +488 -0
  9. package/build/resources/ui-ux-data/guidelines/vercel-web-interface.json +1632 -1632
  10. package/build/resources/ui-ux-data/metadata.json +30 -30
  11. package/build/resources/ui-ux-data/shadcn/blocks.json +2541 -2541
  12. package/build/resources/ui-ux-data/shadcn/components.json +997 -997
  13. package/build/resources/ui-ux-data/themes/presets.json +483 -483
  14. package/build/schemas/index.d.ts +0 -22
  15. package/build/schemas/memory-tools.d.ts +0 -22
  16. package/build/schemas/memory-tools.js +0 -14
  17. package/build/tools/analyze_project.d.ts +1 -0
  18. package/build/tools/analyze_project.js +527 -0
  19. package/build/tools/check_deps.d.ts +13 -0
  20. package/build/tools/check_deps.js +204 -0
  21. package/build/tools/code_insight.js +41 -41
  22. package/build/tools/convert.d.ts +13 -0
  23. package/build/tools/convert.js +599 -0
  24. package/build/tools/css_order.d.ts +13 -0
  25. package/build/tools/css_order.js +81 -0
  26. package/build/tools/debug.d.ts +13 -0
  27. package/build/tools/debug.js +131 -0
  28. package/build/tools/design2code.d.ts +20 -0
  29. package/build/tools/design2code.js +426 -0
  30. package/build/tools/detect_shell.d.ts +6 -0
  31. package/build/tools/detect_shell.js +151 -0
  32. package/build/tools/explain.d.ts +13 -0
  33. package/build/tools/explain.js +390 -0
  34. package/build/tools/fix.d.ts +13 -0
  35. package/build/tools/fix.js +303 -0
  36. package/build/tools/fix_bug.js +161 -161
  37. package/build/tools/gen_mock.d.ts +22 -0
  38. package/build/tools/gen_mock.js +269 -0
  39. package/build/tools/gen_skill.d.ts +13 -0
  40. package/build/tools/gen_skill.js +560 -0
  41. package/build/tools/genapi.d.ts +13 -0
  42. package/build/tools/genapi.js +174 -0
  43. package/build/tools/genchangelog.d.ts +13 -0
  44. package/build/tools/genchangelog.js +250 -0
  45. package/build/tools/gencommit.js +60 -60
  46. package/build/tools/gendoc.d.ts +13 -0
  47. package/build/tools/gendoc.js +232 -0
  48. package/build/tools/genpr.d.ts +13 -0
  49. package/build/tools/genpr.js +194 -0
  50. package/build/tools/genreadme.d.ts +13 -0
  51. package/build/tools/genreadme.js +626 -0
  52. package/build/tools/gensql.d.ts +13 -0
  53. package/build/tools/gensql.js +320 -0
  54. package/build/tools/genui.d.ts +13 -0
  55. package/build/tools/genui.js +803 -0
  56. package/build/tools/index.d.ts +0 -1
  57. package/build/tools/index.js +0 -1
  58. package/build/tools/init_component_catalog.d.ts +22 -0
  59. package/build/tools/init_component_catalog.js +809 -0
  60. package/build/tools/init_project_context.js +432 -432
  61. package/build/tools/init_setting.d.ts +13 -0
  62. package/build/tools/init_setting.js +47 -0
  63. package/build/tools/perf.d.ts +13 -0
  64. package/build/tools/perf.js +409 -0
  65. package/build/tools/render_ui.d.ts +22 -0
  66. package/build/tools/render_ui.js +384 -0
  67. package/build/tools/resolve_conflict.d.ts +13 -0
  68. package/build/tools/resolve_conflict.js +349 -0
  69. package/build/tools/security_scan.d.ts +22 -0
  70. package/build/tools/security_scan.js +323 -0
  71. package/build/tools/split.d.ts +13 -0
  72. package/build/tools/split.js +599 -0
  73. package/build/tools/start_api.d.ts +13 -0
  74. package/build/tools/start_api.js +193 -0
  75. package/build/tools/start_bugfix.js +233 -233
  76. package/build/tools/start_doc.d.ts +13 -0
  77. package/build/tools/start_doc.js +207 -0
  78. package/build/tools/start_feature.js +117 -117
  79. package/build/tools/start_product.js +1 -1
  80. package/build/tools/start_refactor.d.ts +13 -0
  81. package/build/tools/start_refactor.js +188 -0
  82. package/build/tools/start_release.d.ts +13 -0
  83. package/build/tools/start_release.js +167 -0
  84. package/build/tools/start_review.d.ts +13 -0
  85. package/build/tools/start_review.js +175 -0
  86. package/build/tools/start_ui.js +399 -399
  87. package/build/tools/ui-ux-tools.js +290 -290
  88. package/build/utils/__tests__/vercel-guidelines-sync.unit.test.js +12 -12
  89. package/build/utils/themes-sync.js +8 -8
  90. package/package.json +81 -83
  91. package/build/lib/__tests__/memory-orchestration.unit.test.js +0 -88
  92. package/build/lib/__tests__/memory-payload.unit.test.js +0 -35
  93. package/build/lib/cursor-history-client.d.ts +0 -54
  94. package/build/lib/cursor-history-client.js +0 -240
  95. package/build/tools/__tests__/cursor-history.unit.test.d.ts +0 -1
  96. package/build/tools/__tests__/cursor-history.unit.test.js +0 -38
  97. package/build/tools/cursor_read_conversation.d.ts +0 -7
  98. package/build/tools/cursor_read_conversation.js +0 -36
  99. package/docs/.mcp-probe/layout.json +0 -11
  100. package/docs/CNAME +0 -1
  101. package/docs/assets/font/MaterialSymbolsOutlined.codepoints +0 -4102
  102. package/docs/assets/font/MaterialSymbolsOutlined.ttf +0 -0
  103. package/docs/assets/font/noto-sans-sc-400.ttf +0 -0
  104. package/docs/assets/font/noto-sans-sc-700.ttf +0 -0
  105. package/docs/assets/font/noto-sans-sc-900.ttf +0 -0
  106. package/docs/assets/js/i18n.js +0 -375
  107. package/docs/assets/js/tailwind.js +0 -83
  108. package/docs/assets/logo-zh.png +0 -0
  109. package/docs/assets/logo.png +0 -0
  110. package/docs/data/tools.js +0 -523
  111. package/docs/i18n/all-tools/en.json +0 -190
  112. package/docs/i18n/all-tools/ja.json +0 -171
  113. package/docs/i18n/all-tools/ko.json +0 -171
  114. package/docs/i18n/all-tools/zh-CN.json +0 -190
  115. package/docs/i18n/en.json +0 -626
  116. package/docs/i18n/ja.json +0 -602
  117. package/docs/i18n/ko.json +0 -602
  118. package/docs/i18n/zh-CN.json +0 -626
  119. package/docs/index.html +0 -327
  120. package/docs/memory-local-setup.md +0 -315
  121. package/docs/memory-local-setup.zh-CN.md +0 -283
  122. package/docs/pages/all-tools.html +0 -515
  123. package/docs/pages/examples.html +0 -717
  124. package/docs/pages/getting-started.html +0 -964
  125. package/docs/pages/migration.html +0 -308
  126. package/docs/specs/user-auth/design.md +0 -82
  127. package/docs/specs/user-auth/requirements.md +0 -52
  128. package/docs/specs/user-auth/tasks.md +0 -55
  129. /package/build/{lib/__tests__/memory-orchestration.unit.test.d.ts → utils/design-docs-generator.d.ts} +0 -0
  130. /package/build/{lib/__tests__/memory-payload.unit.test.d.ts → utils/design-docs-generator.js} +0 -0
package/README.md CHANGED
@@ -1,779 +1,755 @@
1
- # mcp-probe-kit — Know the Context, Feed the Moment
2
-
3
- <div align="center">
4
- <img src="docs/assets/logo.png" alt="įŸĨæ—ķMCP Logo" width="160"/>
5
- <h1>įŸĨæ—ķMCP | mcp-probe-kit</h1>
6
- <p><strong>Know the Context, Feed the Moment.</strong></p>
7
- <p>
8
- <code>Introspection</code> · <code>Context Hydration</code> · <code>Delegated Orchestration</code>
9
- </p>
10
- </div>
11
-
12
- ---
13
-
14
- <!-- mcp-name: io.github.mybolide/mcp-probe-kit -->
15
-
16
- > **Talk is cheap, show me the Context.**
17
- >
18
- > 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 27 tools—it's a context-aware system that helps AI agents grasp what you're building.
19
-
20
- **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)
21
-
22
- [![npm version](https://img.shields.io/npm/v/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
23
- [![npm downloads](https://img.shields.io/npm/dm/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
24
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
25
- [![GitHub stars](https://img.shields.io/github/stars/mybolide/mcp-probe-kit.svg)](https://github.com/mybolide/mcp-probe-kit/stargazers)
26
-
27
- > 🚀 AI-Powered Complete Development Toolkit - Covering the Entire Development Lifecycle
28
-
29
- A powerful MCP (Model Context Protocol) server providing **27 tools** covering the complete workflow from product analysis to final release (Requirements → Design → Development → Quality → Release), all tools support **structured output**.
30
-
31
- **🎉 v3.0 Major Update**: Streamlined tool count, focus on core competencies, eliminate choice paralysis, let AI do more native work
32
-
33
- **Supports All MCP Clients**: Cursor, Claude Desktop, Cline, Continue, and more
34
-
35
- **Protocol Version**: MCP 2025-11-25 · **SDK**: @modelcontextprotocol/sdk 1.27.1
36
-
37
- ---
38
-
39
- ## 📚 Complete Documentation
40
-
41
- **👉 [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)**
42
-
43
- - [Quick Start](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html) - Setup in 5 minutes
44
- - [Local Memory Stack (Qdrant + Nomic Embed)](docs/memory-local-setup.md) - Docker Compose, ports `50008` / `50012`, MCP env
45
- - [All Tools](https://mcp-probe-kit.bytezonex.com/pages/all-tools.html) - Complete list of 27 tools
46
- - [Best Practices](https://mcp-probe-kit.bytezonex.com/pages/examples.html) - Full development workflow guide
47
- - [v3.0 Migration Guide](https://mcp-probe-kit.bytezonex.com/pages/migration.html) - Upgrade from v2.x to v3.0
48
-
49
- ---
50
-
51
- ## âœĻ Core Features
52
-
53
- ### ðŸ“Ķ 28 Tools
54
-
55
- - **🔄 Workflow Orchestration** (6 tools) - One-click complex development workflows
56
- - `start_feature`, `start_bugfix`, `start_onboard`, `start_ui`, `start_product`, `start_ralph`
57
- - **🔍 Code Analysis** (4 tools) - Code quality, refactoring, and graph insight
58
- - `code_review`, `code_insight`, `fix_bug`, `refactor`
59
- - **📝 Git Tools** (2 tools) - Git commits and work reports
60
- - `gencommit`, `git_work_report`
61
- - **⚡ Code Generation** (1 tool) - Test generation
62
- - `gentest`
63
- - **ðŸ“Ķ Project Management** (6 tools) - Project initialization and requirements management
64
- - `init_project`, `init_project_context`, `add_feature`, `estimate`, `interview`, `ask_user`
65
- - **ðŸŽĻ UI/UX Utilities** (3 tools) - Design systems and UI data synchronization
66
- - `ui_design_system`, `ui_search`, `sync_ui_data`
67
- - **🧠 Memory & Cursor History** (5 tools) - Reusable asset memory and local Cursor conversation retrieval
68
- - `search_memory`, `read_memory_asset`, `memorize_asset`, `scan_and_extract_patterns`, `cursor_read_conversation`
69
-
70
- ### 🧠 Code Graph Bridge (GitNexus)
71
-
72
- - `code_insight` bridges GitNexus by default for query/context/impact analysis
73
- - The bridge launches `npx -y gitnexus@latest mcp` by default to reduce stale package risk
74
- - `init_project_context` bootstraps baseline graph docs under `docs/graph-insights/`; if `docs/project-context.md` already exists, it preserves the old context docs and only backfills graph docs plus the index entry
75
- - `start_feature` refreshes the GitNexus index and runs task-level `query/context/impact` narrowing before spec generation to reduce over-scoping
76
- - `start_bugfix` refreshes the GitNexus index and runs task-level graph analysis before TBP RCA to constrain failure boundary and blast radius
77
- - Older projects that already have `project-context.md` but no graph docs are bootstrapped automatically through the `init_project_context` step
78
- - If GitNexus is unavailable, the server falls back automatically without breaking orchestration
79
- - Real graph queries read the `.gitnexus` index; `docs/graph-insights/latest.md|json` are readable snapshots for humans and AI agents
80
- - Graph snapshots are exposed as resources (`probe://graph/latest`, `probe://graph/history`, `probe://graph/latest.md`)
81
- - Graph snapshots are also persisted to readable files in `.mcp-probe-kit/graph-snapshots` (customizable via `MCP_GRAPH_SNAPSHOT_DIR`)
82
- - Tool responses include `_meta.graph` with snapshot URI and local JSON/Markdown file paths
83
-
84
- ### 🐛 TBP 8-Step RCA for Bug Workflows
85
-
86
- - `start_bugfix` defaults to Toyota-style TBP 8-step root-cause analysis before repair
87
- - `fix_bug` returns a structured TBP skeleton covering phenomenon, timeline, ruled-out paths, boundary, root cause, evidence, and repair plan
88
- - This makes bug, regression, anomaly, and "why didn't it work" investigations follow analyze-first discipline instead of patching symptoms
89
-
90
- ### 🧠 Memory Retrieval and Cursor History
91
-
92
- - Memory tools use **Qdrant** as the vector database backend
93
- - Embedding service supports two modes:
94
- - `ollama`
95
- - `openai-compatible`
96
- - `cursor_read_conversation` reads the local Cursor database directly through Node.js, without Python bridge
97
- - Cursor history currently supports:
98
- - Windows: `%APPDATA%\\Cursor\\User\\globalStorage\\state.vscdb`
99
- - macOS: `~/Library/Application Support/Cursor/User/globalStorage/state.vscdb`
100
- - Linux: `~/.config/Cursor/User/globalStorage/state.vscdb`
101
-
102
- **Memory tools:**
103
- - `search_memory` - Semantic search across the shared memory pool (optionally prefer `type` / `tags`); text output includes `id`, `score`, summary, description, and a `--- content ---` body (default up to 1500 chars via `MEMORY_SEARCH_CONTENT_MAX_CHARS`)
104
- - `memorize_asset` - Persist reusable code/spec/pattern assets into vector memory
105
- - `read_memory_asset` - Read full asset content by `asset_id` (text output includes the full `content` body)
106
- - `scan_and_extract_patterns` - Extract reusable patterns from code/file/directory before deciding whether to persist
107
-
108
- **Cross-repo memory pools:** do not rely on `source_project` / `source_path` for shared retrieval; put file paths in `content` instead. Search injection hides foreign `sourcePath` unless `MEMORY_REPO_ID` matches or `MEMORY_SEARCH_SHOW_SOURCE=true`.
109
-
110
- **Memory backend and embedding configuration:**
111
- - Vector database: **Qdrant**
112
- - **Recommended local setup:** `Qdrant (port 50008) + Infinity / nomic-embed (port 50012)` — lighter than Ollama; see **[Local Memory Stack guide](docs/memory-local-setup.md)** (äļ­æ–‡: [memory-local-setup.zh-CN.md](docs/memory-local-setup.zh-CN.md))
113
- - Supported embedding providers:
114
- - `ollama`
115
- - `openai-compatible` (Infinity, OpenAI, etc.)
116
- - Required environment variables for memory write/search:
117
- - `MEMORY_QDRANT_URL`
118
- - `MEMORY_EMBEDDING_URL`
119
- - `MEMORY_EMBEDDING_MODEL`
120
- - Optional environment variables:
121
- - `MEMORY_QDRANT_API_KEY`
122
- - `MEMORY_QDRANT_COLLECTION` (default: `mcp_probe_memory`)
123
- - `MEMORY_EMBEDDING_API_KEY`
124
- - `MEMORY_EMBEDDING_PROVIDER` (`ollama` by default)
125
- - `MEMORY_SEARCH_LIMIT` (default: `3`)
126
- - `MEMORY_SUMMARY_MAX_CHARS` (default: `280`)
127
- - `MEMORY_SEARCH_MIN_SCORE` (default: `0` = disabled; try `0.72` for noisy pools)
128
- - `MEMORY_SEARCH_SHOW_SOURCE` (default: `false`)
129
- - `MEMORY_REPO_ID` (optional; show `sourcePath` only when `sourceProject` matches)
130
- - `MEMORY_INJECTION_CONTENT_MAX_CHARS` (default: `1500`; max content per hit injected into `start_*` guides)
131
- - Behavior notes:
132
- - Read-only memory access only requires `MEMORY_QDRANT_URL`
133
- - Memory write is enabled only when `MEMORY_QDRANT_URL`, `MEMORY_EMBEDDING_URL`, and `MEMORY_EMBEDDING_MODEL` are all configured
134
- - The Qdrant collection is auto-created on first write, and vector dimension is inferred from the first embedding response
135
-
136
- **Recommended local memory setup (Qdrant + Nomic Embed / Infinity):**
137
-
138
- Full Docker Compose, ports, and troubleshooting: **[docs/memory-local-setup.md](docs/memory-local-setup.md)**
139
-
140
- ```json
141
- {
142
- "mcpServers": {
143
- "mcp-probe-kit": {
144
- "command": "npx",
145
- "args": ["-y", "mcp-probe-kit@latest"],
146
- "env": {
147
- "MEMORY_QDRANT_URL": "http://127.0.0.1:50008",
148
- "MEMORY_QDRANT_API_KEY": "your-qdrant-api-key",
149
- "MEMORY_QDRANT_COLLECTION": "mcp_probe_memory",
150
- "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
151
- "MEMORY_EMBEDDING_URL": "http://127.0.0.1:50012/embeddings",
152
- "MEMORY_EMBEDDING_MODEL": "nomic-ai/nomic-embed-text-v1.5",
153
- "MEMORY_EMBEDDING_API_KEY": "your-infinity-api-key",
154
- "MEMORY_SEARCH_LIMIT": "3",
155
- "MEMORY_SUMMARY_MAX_CHARS": "280"
156
- }
157
- }
158
- }
159
- }
160
- ```
161
-
162
- **Alternative: Qdrant + Ollama** (if you already run Ollama):
163
-
164
- ```bash
165
- docker run -d --name mcp-qdrant -p 6333:6333 qdrant/qdrant
166
- ollama pull nomic-embed-text
167
- ```
168
-
169
- ```json
170
- "MEMORY_QDRANT_URL": "http://127.0.0.1:6333",
171
- "MEMORY_EMBEDDING_PROVIDER": "ollama",
172
- "MEMORY_EMBEDDING_URL": "http://127.0.0.1:11434/api/embeddings",
173
- "MEMORY_EMBEDDING_MODEL": "nomic-embed-text"
174
- ```
175
-
176
- **OpenAI-compatible embedding (hosted API):**
177
- ```json
178
- {
179
- "mcpServers": {
180
- "mcp-probe-kit": {
181
- "command": "npx",
182
- "args": ["-y", "mcp-probe-kit@latest"],
183
- "env": {
184
- "MEMORY_QDRANT_URL": "http://127.0.0.1:6333",
185
- "MEMORY_QDRANT_COLLECTION": "mcp_probe_memory",
186
- "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
187
- "MEMORY_EMBEDDING_URL": "https://your-embedding-endpoint/v1/embeddings",
188
- "MEMORY_EMBEDDING_API_KEY": "your-api-key",
189
- "MEMORY_EMBEDDING_MODEL": "text-embedding-3-small"
190
- }
191
- }
192
- }
193
- }
194
- ```
195
-
196
- **Cursor history tools:**
197
- - `cursor_read_conversation` - Read a single local Cursor conversation timeline by `composer_id`
198
-
199
- ### ðŸŽŊ Structured Output
200
-
201
- Core and orchestration tools support **structured output**, returning machine-readable JSON data, improving AI parsing accuracy, supporting tool chaining and state tracking.
202
-
203
- ### ⏱ïļ Native Tasks, Progress, and Cancellation
204
-
205
- - Built on MCP SDK native task support (`taskStore` + `taskMessageQueue`)
206
- - Supports task lifecycle endpoints: `tasks/get`, `tasks/result`, `tasks/list`, `tasks/cancel`
207
- - Advertises `capabilities.tasks.requests.tools.call` so clients can create tasks for `tools/call`
208
- - Emits `notifications/progress` when client provides `_meta.progressToken`
209
- - Handles request cancellation via `AbortSignal` and returns a clear cancellation error
210
- - Long-running orchestration tools (`start_*`) and `sync_ui_data` support cooperative cancellation/progress callbacks
211
-
212
- ### 🔌 Extensions & UI Apps (Optional)
213
-
214
- - Trace metadata passthrough: request `_meta.trace` is preserved in tool responses (`_meta.trace`)
215
- - Optional extensions capability switch: enable with `MCP_ENABLE_EXTENSIONS_CAPABILITY=1`
216
- - Optional MCP Apps resource output for UI tools: enable with `MCP_ENABLE_UI_APPS=1`
217
- - UI tools can expose preview resources via `ui://...` and response `_meta.ui.resourceUri`
218
-
219
- ### 🧭 Delegated Orchestration Protocol
220
-
221
- All `start_*` orchestration tools return an **execution plan** in `structuredContent.metadata.plan`.
222
- AI needs to **call tools step by step and persist files**, rather than the tool executing internally.
223
-
224
- **Plan Schema (Core Fields)**:
225
- ```json
226
- {
227
- "mode": "delegated",
228
- "steps": [
229
- {
230
- "id": "spec",
231
- "tool": "add_feature",
232
- "args": { "feature_name": "user-auth", "description": "User authentication feature" },
233
- "outputs": ["docs/specs/user-auth/requirements.md"]
234
- }
235
- ]
236
- }
237
- ```
238
-
239
- **Field Description**:
240
- - `mode`: Fixed as `delegated`
241
- - `steps`: Array of execution steps
242
- - `tool`: Tool name (e.g. `add_feature`)
243
- - `action`: Manual action description when no tool (e.g. `update_project_context`)
244
- - `args`: Tool parameters
245
- - `outputs`: Expected artifacts
246
- - `when/dependsOn/note`: Optional conditions and notes
247
-
248
- ### ðŸ§Đ Structured Output Field Specification (Key Fields)
249
-
250
- Both orchestration and atomic tools return `structuredContent`, common fields:
251
- - `summary`: One-line summary
252
- - `status`: Status (pending/success/failed/partial)
253
- - `steps`: Execution steps (orchestration tools)
254
- - `artifacts`: Artifact list (path + purpose)
255
- - `metadata.plan`: Delegated execution plan (only start_*)
256
- - `specArtifacts`: Specification artifacts (start_feature)
257
- - `estimate`: Estimation results (start_feature / estimate)
258
-
259
- ### 🧠 Requirements Clarification Mode (Requirements Loop)
260
-
261
- When requirements are unclear, use `requirements_mode=loop` in `start_feature / start_bugfix / start_ui`.
262
- This mode performs 1-2 rounds of structured clarification before entering spec/fix/UI execution.
263
-
264
- **Example:**
265
- ```json
266
- {
267
- "feature_name": "user-auth",
268
- "description": "User authentication feature",
269
- "requirements_mode": "loop",
270
- "loop_max_rounds": 2,
271
- "loop_question_budget": 5
272
- }
273
- ```
274
-
275
- ### ðŸ§Đ Template System (Regular Model Friendly)
276
-
277
- `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).
278
-
279
- **Example:**
280
- ```json
281
- {
282
- "description": "Add user authentication feature",
283
- "template_profile": "auto"
284
- }
285
- ```
286
-
287
- **Applicable Tools**:
288
- - `start_feature` passes `template_profile` to `add_feature`
289
- - `start_bugfix` / `start_ui` also support `template_profile` for controlling guidance strength (auto/guided/strict)
290
-
291
- **Template Profile Strategy**:
292
- - `guided`: Less/incomplete requirements info, regular model priority
293
- - `strict`: Requirements structured, prefer more compact guidance
294
- - `auto`: Default recommendation, auto-selects guided/strict
295
-
296
- ### 🔄 Workflow Orchestration
297
-
298
- 6 intelligent orchestration tools that automatically combine multiple basic tools for one-click complex development workflows:
299
- - `start_feature` - New feature development (Requirements → Design → Estimation)
300
- - `start_bugfix` - Bug fixing (TBP 8-step RCA → Fix → Testing)
301
- - `start_onboard` - Project onboarding (Generate project context docs)
302
- - `start_ui` - UI development (Design system → Components → Code)
303
- - `start_product` - Product design (PRD → Prototype → Design system → HTML)
304
- - `start_ralph` - Ralph Loop (Iterative development until goal completion)
305
-
306
- ### 🚀 Product Design Workflow
307
-
308
- `start_product` is a complete product design orchestration tool, from requirements to interactive prototype:
309
-
310
- **Workflow:**
311
- 1. **Requirements Analysis** - Generate standard PRD (product overview, feature requirements, page list)
312
- 2. **Prototype Design** - Generate detailed prototype docs for each page
313
- 3. **Design System** - Generate design specifications based on product type
314
- 4. **HTML Prototype** - Generate interactive prototype viewable in browser
315
- 5. **Project Context** - Auto-update project documentation
316
-
317
- **Structured Output Additions**:
318
- - `start_product.structuredContent.artifacts`: Artifact list (PRD, prototypes, design system, etc.)
319
- - `interview.structuredContent.mode`: `usage` / `questions` / `record`
320
-
321
- ### ðŸŽĻ UI/UX Pro Max
322
-
323
- 4 UI/UX tools with `start_ui` as the unified entry point:
324
- - `start_ui` - One-click UI development (supports intelligent mode) (orchestration tool)
325
- - `ui_design_system` - Intelligent design system generation
326
- - `ui_search` - UI/UX data search (BM25 algorithm)
327
- - `sync_ui_data` - Sync latest UI/UX data locally
328
-
329
- **Note**: `start_ui` automatically calls `ui_design_system` and `ui_search`, you don't need to call them separately.
330
-
331
- **Inspiration:**
332
- - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX design system philosophy
333
- - [json-render](https://github.com/vercel-labs/json-render) - JSON template rendering engine
334
-
335
- **Skill Bridge for UI/PRD workflows:**
336
- - `start_ui` and `start_product` now include a Skill Bridge section in guidance and `structuredContent.metadata.skills`.
337
- - Recommended skill call order: `ui-ux-pro-max` → `interaction-design` → `frontend-design`.
338
- - If some skills are missing, workflow continues with MCP main plan and marks unavailable skills in metadata.
339
-
340
- **Why use `sync_ui_data`?**
341
-
342
- 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:
343
- - ðŸŽĻ Color schemes (mainstream brand colors, color palettes)
344
- - ðŸ”Ģ Icon libraries (React Icons, Heroicons, etc.)
345
- - 📊 Chart components (Recharts, Chart.js, etc.)
346
- - ðŸŽŊ Landing page templates (SaaS, e-commerce, government, etc.)
347
- - 📐 Design specifications (spacing, fonts, shadows, etc.)
348
-
349
- **Data Sync Strategy:**
350
- 1. **Embedded Data**: Synced at build time, works offline
351
- 2. **Background Auto Sync**: Downloads latest data to `~/.mcp-probe-kit/ui-ux-data/` without changing current session output
352
- 3. **Next-Start Activation**: Newly downloaded data is applied on next process start (keeps current session deterministic)
353
- 4. **Manual Sync**: Use `sync_ui_data` to force refresh cache immediately (still applies next start by default)
354
-
355
- This ensures `start_ui` can generate professional-grade UI code even offline.
356
-
357
- ### ðŸŽĪ Requirements Interview
358
-
359
- 2 interview tools to clarify requirements before development:
360
- - `interview` - Structured requirements interview
361
- - `ask_user` - AI proactive questioning
362
-
363
- ---
364
-
365
- ## 🧭 Tool Selection Guide
366
-
367
- ### When to use orchestration tools vs individual tools?
368
-
369
- **Use orchestration tools (start_*) when:**
370
- - ✅ Need complete workflow (multiple steps)
371
- - ✅ Want to automate multiple tasks
372
- - ✅ Need to generate multiple artifacts (docs, code, tests, etc.)
373
-
374
- **Use individual tools when:**
375
- - ✅ Only need specific functionality
376
- - ✅ Already have project context docs
377
- - ✅ Need more fine-grained control
378
-
379
- ### Common Scenario Selection
380
-
381
- | Scenario | Recommended Tool | Reason |
382
- |---------|-----------------|--------|
383
- | Develop new feature (complete flow) | `start_feature` | Auto-complete: spec→estimation |
384
- | Only need feature spec docs | `add_feature` | More lightweight, only generates docs |
385
- | Fix bug (complete flow) | `start_bugfix` | Root-cause-first flow: TBP RCA → fix → test |
386
- | Only need bug analysis | `fix_bug` | TBP 8-step RCA only, without full orchestration |
387
- | Generate design system | `ui_design_system` | Directly generate design specs |
388
- | Develop UI components | `start_ui` | Complete flow: design→components→code |
389
- | Product design (requirements to prototype) | `start_product` | One-click: PRD→prototype→HTML |
390
- | One-sentence requirement analysis | `init_project` | Generate complete project spec docs |
391
- | Project onboarding docs | `init_project_context` | Generate tech stack/architecture/conventions |
392
-
393
- ---
394
-
395
- ## 🚀 Quick Start
396
-
397
- ### Method 1: Use directly with npx (Recommended)
398
-
399
- No installation needed, use the latest version directly.
400
-
401
- #### Cursor / Cline Configuration
402
-
403
- **Config file location:**
404
- - Windows: `%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`
405
- - macOS: `~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
406
- - Linux: `~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
407
-
408
- **Config content:**
409
- ```json
410
- {
411
- "mcpServers": {
412
- "mcp-probe-kit": {
413
- "command": "npx",
414
- "args": ["mcp-probe-kit@latest"]
415
- }
416
- }
417
- }
418
- ```
419
-
420
- #### Claude Desktop Configuration
421
-
422
- **Config file location:**
423
- - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
424
- - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
425
- - Linux: `~/.config/Claude/claude_desktop_config.json`
426
-
427
- **Config content:**
428
- ```json
429
- {
430
- "mcpServers": {
431
- "mcp-probe-kit": {
432
- "command": "npx",
433
- "args": ["-y", "mcp-probe-kit@latest"]
434
- }
435
- }
436
- }
437
- ```
438
-
439
- #### OpenCode Configuration
440
-
441
- **Config file location:**
442
- - Project-level: `opencode.json` (in project root)
443
- - Global: `~/.config/opencode/opencode.json`
444
-
445
- **Config content:**
446
- ```json
447
- {
448
- "mcp": {
449
- "mcp-probe-kit": {
450
- "type": "local",
451
- "command": ["npx", "-y", "mcp-probe-kit@latest"],
452
- "enabled": true
453
- }
454
- }
455
- }
456
- ```
457
-
458
- > **Note:** OpenCode uses `opencode.json` with a different schema from Cursor/Claude Desktop. The key `mcp` replaces `mcpServers`, `command` is an array, `type: "local"` is required, and environment variables use `environment` instead of `env`. See [OpenCode MCP docs](https://opencode.ai/docs/mcp) for details.
459
-
460
- ### Method 2: Global Installation
461
-
462
- ```bash
463
- npm install -g mcp-probe-kit
464
- ```
465
-
466
- Use in config file:
467
- ```json
468
- {
469
- "mcpServers": {
470
- "mcp-probe-kit": {
471
- "command": "mcp-probe-kit"
472
- }
473
- }
474
- }
475
- ```
476
-
477
- ### Optional Memory System Setup
478
-
479
- If you want to use `memorize_asset`, `read_memory_asset`, and `scan_and_extract_patterns`, you need both:
480
-
481
- 1. A **Qdrant** vector database
482
- 2. An **embedding service** in either `ollama` or `openai-compatible` mode
483
-
484
- **Full guide (Docker Compose for Qdrant + Infinity, ports `50008` / `50012`, MCP env, smoke tests):**
485
-
486
- - English: [docs/memory-local-setup.md](docs/memory-local-setup.md)
487
- - äļ­æ–‡: [docs/memory-local-setup.zh-CN.md](docs/memory-local-setup.zh-CN.md)
488
-
489
- #### Option A: Qdrant + Nomic Embed / Infinity (recommended)
490
-
491
- Lightweight local stack; no Ollama. Deploy Qdrant and `nomic-embed` via Docker Compose (see guide), then:
492
-
493
- ```json
494
- {
495
- "mcpServers": {
496
- "mcp-probe-kit": {
497
- "command": "npx",
498
- "args": ["-y", "mcp-probe-kit@latest"],
499
- "env": {
500
- "MEMORY_QDRANT_URL": "http://127.0.0.1:50008",
501
- "MEMORY_QDRANT_API_KEY": "your-qdrant-api-key",
502
- "MEMORY_QDRANT_COLLECTION": "mcp_probe_memory",
503
- "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
504
- "MEMORY_EMBEDDING_URL": "http://127.0.0.1:50012/embeddings",
505
- "MEMORY_EMBEDDING_MODEL": "nomic-ai/nomic-embed-text-v1.5",
506
- "MEMORY_EMBEDDING_API_KEY": "your-infinity-api-key",
507
- "MEMORY_SEARCH_LIMIT": "3",
508
- "MEMORY_SUMMARY_MAX_CHARS": "280"
509
- }
510
- }
511
- }
512
- }
513
- ```
514
-
515
- > Embedding URL must be `/embeddings` (not `/v1/embeddings`). Qdrant requires `api-key` when `QDRANT__SERVICE__API_KEY` is set.
516
-
517
- #### Option B: Qdrant + Ollama
518
-
519
- ```bash
520
- docker run -d --name mcp-qdrant -p 6333:6333 qdrant/qdrant
521
- ollama pull nomic-embed-text
522
- ```
523
-
524
- ```json
525
- "MEMORY_QDRANT_URL": "http://127.0.0.1:6333",
526
- "MEMORY_EMBEDDING_PROVIDER": "ollama",
527
- "MEMORY_EMBEDDING_URL": "http://127.0.0.1:11434/api/embeddings",
528
- "MEMORY_EMBEDDING_MODEL": "nomic-embed-text"
529
- ```
530
-
531
- #### Option C: Qdrant + hosted OpenAI-compatible API
532
-
533
- ```json
534
- "MEMORY_QDRANT_URL": "http://127.0.0.1:50008",
535
- "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
536
- "MEMORY_EMBEDDING_URL": "https://your-embedding-endpoint/v1/embeddings",
537
- "MEMORY_EMBEDDING_API_KEY": "your-api-key",
538
- "MEMORY_EMBEDDING_MODEL": "text-embedding-3-small"
539
- ```
540
-
541
- #### Memory Environment Variables
542
-
543
- - `MEMORY_QDRANT_URL`: Qdrant base URL, required for all memory features
544
- - `MEMORY_QDRANT_API_KEY`: Optional Qdrant API key
545
- - `MEMORY_QDRANT_COLLECTION`: Collection name, default `mcp_probe_memory`
546
- - `MEMORY_EMBEDDING_PROVIDER`: `ollama` or `openai-compatible`
547
- - `MEMORY_EMBEDDING_URL`: Embedding endpoint URL
548
- - `MEMORY_EMBEDDING_API_KEY`: Optional for Ollama, usually required for hosted OpenAI-compatible providers
549
- - `MEMORY_EMBEDDING_MODEL`: Default is `nomic-embed-text`
550
- - `MEMORY_SEARCH_LIMIT`: Default search result count is `3`
551
- - `MEMORY_SUMMARY_MAX_CHARS`: Default summary truncation length is `280`
552
-
553
- #### Notes
554
-
555
- - Memory write capability is enabled only when `MEMORY_QDRANT_URL`, `MEMORY_EMBEDDING_URL`, and `MEMORY_EMBEDDING_MODEL` are configured
556
- - Memory read capability only requires `MEMORY_QDRANT_URL`
557
- - Qdrant collections are auto-created on first write with `Cosine` distance
558
- - Vector size is inferred from the first embedding response
559
-
560
- ### Cursor History Support
561
-
562
- `cursor_read_conversation` does not require Qdrant or embedding configuration.
563
-
564
- Supported platforms:
565
-
566
- - Windows
567
- - macOS
568
- - Linux
569
-
570
- Requirements:
571
-
572
- - Cursor must be installed locally
573
- - Cursor local database must exist under `User/globalStorage/state.vscdb`
574
- - Compatibility depends on Cursor's current local database schema
575
-
576
- ### Windows Notes for Graph Tools
577
-
578
- Applies to `code_insight`, `start_feature`, `start_bugfix`, and `init_project_context`.
579
-
580
- - The GitNexus bridge uses `npx -y gitnexus@latest mcp` by default.
581
- - On Windows, the first cold start can take 20+ seconds because `npx` may check/download packages.
582
- - Some GitNexus dependencies use `tree-sitter-*` native modules. If your machine lacks Visual Studio Build Tools, the first install may fail with errors like `gyp ERR! find VS could not find a version of Visual Studio 2017 or newer to use`.
583
-
584
- Recommended on Windows:
585
-
586
- 1. Install Visual Studio Build Tools with the C++ workload if you use graph-aware tools regularly.
587
- 2. Prefer stable local/global CLI usage for GitNexus when your MCP client supports `env`.
588
- 3. Increase GitNexus connect/call timeouts on slower or first-run environments.
589
-
590
- Quick install command (Windows):
591
-
592
- ```powershell
593
- winget install Microsoft.VisualStudio.2022.BuildTools
594
- ```
595
-
596
- Example config using a preinstalled `gitnexus` CLI:
597
-
598
- ```json
599
- {
600
- "mcpServers": {
601
- "mcp-probe-kit": {
602
- "command": "mcp-probe-kit",
603
- "env": {
604
- "MCP_GITNEXUS_COMMAND": "gitnexus",
605
- "MCP_GITNEXUS_ARGS": "mcp",
606
- "MCP_GITNEXUS_CONNECT_TIMEOUT_MS": "30000",
607
- "MCP_GITNEXUS_TIMEOUT_MS": "45000"
608
- }
609
- }
610
- }
611
- }
612
- ```
613
-
614
- ### Restart Client
615
-
616
- After configuration, **completely quit and reopen** your MCP client.
617
-
618
- **👉 [Detailed Installation Guide](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
619
-
620
- ---
621
-
622
- ## ðŸ’Ą Usage Examples
623
-
624
- ### Daily Development
625
- ```bash
626
- code_review @feature.ts # Code review
627
- gentest @feature.ts # Generate tests
628
- gencommit # Generate commit message
629
- ```
630
-
631
- ### New Feature Development
632
- ```bash
633
- start_feature user-auth "User authentication feature"
634
- # Auto-complete: Requirements analysis → Design → Effort estimation
635
- ```
636
-
637
- ### Bug Fixing
638
- ```bash
639
- start_bugfix
640
- # Then paste error message
641
- # Auto-complete: Problem location → Fix solution → Test code
642
- ```
643
-
644
- ### Product Design
645
- ```bash
646
- start_product "Online Education Platform" --product_type=SaaS
647
- # Auto-complete: PRD → Prototype → Design system → HTML prototype
648
- ```
649
-
650
- ### UI Development
651
- ```bash
652
- start_ui "Login Page" --mode=auto
653
- # Auto-complete: Design system → Component generation → Code output
654
- ```
655
-
656
- ### Project Context Documentation
657
- ```bash
658
- # Single file mode (default) - Generate a complete project-context.md
659
- init_project_context
660
-
661
- # Modular mode - Generate 6 category docs (suitable for large projects)
662
- init_project_context --mode=modular
663
- # Generates: project-context.md (index) + 5 category docs
664
- ```
665
-
666
- ### Git Work Report
667
- ```bash
668
- # Generate daily report
669
- git_work_report --date 2026-02-03
670
-
671
- # Generate weekly report
672
- git_work_report --start_date 2026-02-01 --end_date 2026-02-07
673
-
674
- # Save to file
675
- git_work_report --date 2026-02-03 --output_file daily-report.md
676
- # Auto-analyze Git diff, generate concise professional report
677
- # If direct command fails, auto-provides temp script solution (auto-deletes after execution)
678
- ```
679
-
680
- **👉 [More Usage Examples](https://mcp-probe-kit.bytezonex.com/pages/examples.html)**
681
-
682
- ---
683
-
684
- ## ❓ FAQ
685
-
686
- ### Q1: Tool not working or errors?
687
-
688
- Check detailed logs:
689
-
690
- **Windows (PowerShell):**
691
- ```powershell
692
- npx -y mcp-probe-kit@latest 2>&1 | Tee-Object -FilePath .\mcp-probe-kit.log
693
- ```
694
-
695
- **macOS/Linux:**
696
- ```bash
697
- npx -y mcp-probe-kit@latest 2>&1 | tee ./mcp-probe-kit.log
698
- ```
699
-
700
- ### Q2: Client not recognizing tools after configuration?
701
-
702
- 1. **Restart client** (completely quit then reopen)
703
- 2. Check config file path is correct
704
- 3. Confirm JSON format is correct, no syntax errors
705
- 4. Check client developer tools or logs for error messages
706
-
707
- ### Q3: How to update to latest version?
708
-
709
- **npx method (Recommended):**
710
- Use `@latest` tag in config, automatically uses latest version.
711
-
712
- **Global installation method:**
713
- ```bash
714
- npm update -g mcp-probe-kit
715
- ```
716
-
717
- ### Q4: Why are graph-aware tools slow or timing out on Windows the first time?
718
-
719
- This usually affects `code_insight`, `start_feature`, `start_bugfix`, and `init_project_context`.
720
-
721
- Common causes:
722
-
723
- 1. `npx -y gitnexus@latest mcp` performs a cold start and may spend 20+ seconds checking/downloading packages.
724
- 2. GitNexus may need native `tree-sitter-*` modules, which can require Visual Studio Build Tools on Windows.
725
-
726
- If you see logs like:
727
-
728
- ```text
729
- gyp ERR! find VS could not find a version of Visual Studio 2017 or newer to use
730
- gyp ERR! find VS - missing any VC++ toolset
731
- ```
732
-
733
- Try this:
734
-
735
- 1. Install Visual Studio Build Tools with the C++ workload.
736
- 2. Retry once after dependencies finish installing.
737
- 3. If your client supports `env`, switch the bridge to a preinstalled `gitnexus` CLI and raise:
738
- `MCP_GITNEXUS_CONNECT_TIMEOUT_MS`
739
- `MCP_GITNEXUS_TIMEOUT_MS`
740
-
741
- **👉 [More FAQ](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
742
-
743
- ---
744
-
745
- ## ðŸĪ Contributing
746
-
747
- Issues and Pull Requests welcome!
748
-
749
- **Improvement suggestions:**
750
- - Add useful tools
751
- - Optimize existing tool prompts
752
- - Improve documentation and examples
753
- - Fix bugs
754
-
755
- ---
756
-
757
- ## 📄 License
758
-
759
- MIT License
760
-
761
- ---
762
-
763
- ## 🔗 Related Links
764
-
765
- - **Author**: [Kyle (小åĒĻ)](https://www.bytezonex.com/)
766
- - **GitHub**: [mcp-probe-kit](https://github.com/mybolide/mcp-probe-kit)
767
- - **npm**: [mcp-probe-kit](https://www.npmjs.com/package/mcp-probe-kit)
768
- - **Documentation**: [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)
769
-
770
- **Related Projects:**
771
- - [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) - Official MCP protocol docs
772
- - [GitHub Spec-Kit](https://github.com/github/spec-kit) - GitHub spec-driven development toolkit
773
- - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX design system philosophy source
774
- - [json-render](https://github.com/vercel-labs/json-render) - JSON template rendering engine inspiration
775
- - [uipro-cli](https://www.npmjs.com/package/uipro-cli) - UI/UX data source
776
-
777
- ---
778
-
779
- **Made with âĪïļ for AI-Powered Development**
1
+ # mcp-probe-kit — Know the Context, Feed the Moment
2
+
3
+ <div align="center">
4
+ <img src="docs/assets/logo.png" alt="įŸĨæ—ķMCP Logo" width="160"/>
5
+ <h1>įŸĨæ—ķMCP | mcp-probe-kit</h1>
6
+ <p><strong>Know the Context, Feed the Moment.</strong></p>
7
+ <p>
8
+ <code>Introspection</code> · <code>Context Hydration</code> · <code>Delegated Orchestration</code>
9
+ </p>
10
+ </div>
11
+
12
+ ---
13
+
14
+ <!-- mcp-name: io.github.mybolide/mcp-probe-kit -->
15
+
16
+ > **Talk is cheap, show me the Context.**
17
+ >
18
+ > 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 27 tools—it's a context-aware system that helps AI agents grasp what you're building.
19
+
20
+ **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)
21
+
22
+ [![npm version](https://img.shields.io/npm/v/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
23
+ [![npm downloads](https://img.shields.io/npm/dm/mcp-probe-kit.svg)](https://www.npmjs.com/package/mcp-probe-kit)
24
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
25
+ [![GitHub stars](https://img.shields.io/github/stars/mybolide/mcp-probe-kit.svg)](https://github.com/mybolide/mcp-probe-kit/stargazers)
26
+
27
+ > 🚀 AI-Powered Complete Development Toolkit - Covering the Entire Development Lifecycle
28
+
29
+ A powerful MCP (Model Context Protocol) server providing **26 tools** covering the complete workflow from product analysis to final release (Requirements → Design → Development → Quality → Release), all tools support **structured output**.
30
+
31
+ **🎉 v3.0 Major Update**: Streamlined tool count, focus on core competencies, eliminate choice paralysis, let AI do more native work
32
+
33
+ **Supports All MCP Clients**: Cursor, Claude Desktop, Cline, Continue, and more
34
+
35
+ **Protocol Version**: MCP 2025-11-25 · **SDK**: @modelcontextprotocol/sdk 1.27.1
36
+
37
+ ---
38
+
39
+ ## 📚 Complete Documentation
40
+
41
+ **👉 [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)**
42
+
43
+ - [Quick Start](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html) - Setup in 5 minutes
44
+ - [Local Memory Stack (Qdrant + Nomic Embed)](docs/memory-local-setup.md) - Docker Compose, ports `50008` / `50012`, MCP env
45
+ - [All Tools](https://mcp-probe-kit.bytezonex.com/pages/all-tools.html) - Complete list of 26 tools
46
+ - [Best Practices](https://mcp-probe-kit.bytezonex.com/pages/examples.html) - Full development workflow guide
47
+ - [v3.0 Migration Guide](https://mcp-probe-kit.bytezonex.com/pages/migration.html) - Upgrade from v2.x to v3.0
48
+
49
+ ---
50
+
51
+ ## âœĻ Core Features
52
+
53
+ ### ðŸ“Ķ 26 Tools
54
+
55
+ - **🔄 Workflow Orchestration** (6 tools) - One-click complex development workflows
56
+ - `start_feature`, `start_bugfix`, `start_onboard`, `start_ui`, `start_product`, `start_ralph`
57
+ - **🔍 Code Analysis** (4 tools) - Code quality, refactoring, and graph insight
58
+ - `code_review`, `code_insight`, `fix_bug`, `refactor`
59
+ - **📝 Git Tools** (2 tools) - Git commits and work reports
60
+ - `gencommit`, `git_work_report`
61
+ - **⚡ Code Generation** (1 tool) - Test generation
62
+ - `gentest`
63
+ - **ðŸ“Ķ Project Management** (6 tools) - Project initialization and requirements management
64
+ - `init_project`, `init_project_context`, `add_feature`, `estimate`, `interview`, `ask_user`
65
+ - **ðŸŽĻ UI/UX Utilities** (3 tools) - Design systems and UI data synchronization
66
+ - `ui_design_system`, `ui_search`, `sync_ui_data`
67
+ - **🧠 Memory** (4 tools) - Reusable asset memory
68
+ - `search_memory`, `read_memory_asset`, `memorize_asset`, `scan_and_extract_patterns`
69
+
70
+ ### 🧠 Code Graph Bridge (GitNexus)
71
+
72
+ - `code_insight` bridges GitNexus by default for query/context/impact analysis
73
+ - The bridge launches `npx -y gitnexus@latest mcp` by default to reduce stale package risk
74
+ - `init_project_context` bootstraps baseline graph docs under `docs/graph-insights/`; if `docs/project-context.md` already exists, it preserves the old context docs and only backfills graph docs plus the index entry
75
+ - `start_feature` refreshes the GitNexus index and runs task-level `query/context/impact` narrowing before spec generation to reduce over-scoping
76
+ - `start_bugfix` refreshes the GitNexus index and runs task-level graph analysis before TBP RCA to constrain failure boundary and blast radius
77
+ - Older projects that already have `project-context.md` but no graph docs are bootstrapped automatically through the `init_project_context` step
78
+ - If GitNexus is unavailable, the server falls back automatically without breaking orchestration
79
+ - Real graph queries read the `.gitnexus` index; `docs/graph-insights/latest.md|json` are readable snapshots for humans and AI agents
80
+ - Graph snapshots are exposed as resources (`probe://graph/latest`, `probe://graph/history`, `probe://graph/latest.md`)
81
+ - Graph snapshots are also persisted to readable files in `.mcp-probe-kit/graph-snapshots` (customizable via `MCP_GRAPH_SNAPSHOT_DIR`)
82
+ - Tool responses include `_meta.graph` with snapshot URI and local JSON/Markdown file paths
83
+
84
+ ### 🐛 TBP 8-Step RCA for Bug Workflows
85
+
86
+ - `start_bugfix` defaults to Toyota-style TBP 8-step root-cause analysis before repair
87
+ - `fix_bug` returns a structured TBP skeleton covering phenomenon, timeline, ruled-out paths, boundary, root cause, evidence, and repair plan
88
+ - This makes bug, regression, anomaly, and "why didn't it work" investigations follow analyze-first discipline instead of patching symptoms
89
+
90
+ ### 🧠 Memory Retrieval
91
+
92
+ - Memory tools use **Qdrant** as the vector database backend
93
+ - Embedding service supports two modes:
94
+ - `ollama`
95
+ - `openai-compatible`
96
+
97
+ **Memory tools:**
98
+ - `search_memory` - Semantic search across the shared memory pool (optionally prefer `type` / `tags`); text output includes `id`, `score`, summary, description, and a `--- content ---` body (default up to 1500 chars via `MEMORY_SEARCH_CONTENT_MAX_CHARS`)
99
+ - `memorize_asset` - Persist reusable code/spec/pattern assets into vector memory
100
+ - `read_memory_asset` - Read full asset content by `asset_id` (text output includes the full `content` body)
101
+ - `scan_and_extract_patterns` - Extract reusable patterns from code/file/directory before deciding whether to persist
102
+
103
+ **Cross-repo memory pools:** do not rely on `source_project` / `source_path` for shared retrieval; put file paths in `content` instead. Search injection hides foreign `sourcePath` unless `MEMORY_REPO_ID` matches or `MEMORY_SEARCH_SHOW_SOURCE=true`.
104
+
105
+ **Memory backend and embedding configuration:**
106
+ - Vector database: **Qdrant**
107
+ - **Recommended local setup:** `Qdrant (port 50008) + Infinity / nomic-embed (port 50012)` — lighter than Ollama; see **[Local Memory Stack guide](docs/memory-local-setup.md)** (äļ­æ–‡: [memory-local-setup.zh-CN.md](docs/memory-local-setup.zh-CN.md))
108
+ - Supported embedding providers:
109
+ - `ollama`
110
+ - `openai-compatible` (Infinity, OpenAI, etc.)
111
+ - Required environment variables for memory write/search:
112
+ - `MEMORY_QDRANT_URL`
113
+ - `MEMORY_EMBEDDING_URL`
114
+ - `MEMORY_EMBEDDING_MODEL`
115
+ - Optional environment variables:
116
+ - `MEMORY_QDRANT_API_KEY`
117
+ - `MEMORY_QDRANT_COLLECTION` (default: `mcp_probe_memory`)
118
+ - `MEMORY_EMBEDDING_API_KEY`
119
+ - `MEMORY_EMBEDDING_PROVIDER` (`ollama` by default)
120
+ - `MEMORY_SEARCH_LIMIT` (default: `3`)
121
+ - `MEMORY_SUMMARY_MAX_CHARS` (default: `280`)
122
+ - `MEMORY_SEARCH_MIN_SCORE` (default: `0` = disabled; try `0.72` for noisy pools)
123
+ - `MEMORY_SEARCH_SHOW_SOURCE` (default: `false`)
124
+ - `MEMORY_REPO_ID` (optional; show `sourcePath` only when `sourceProject` matches)
125
+ - `MEMORY_INJECTION_CONTENT_MAX_CHARS` (default: `1500`; max content per hit injected into `start_*` guides)
126
+ - Behavior notes:
127
+ - Read-only memory access only requires `MEMORY_QDRANT_URL`
128
+ - Memory write is enabled only when `MEMORY_QDRANT_URL`, `MEMORY_EMBEDDING_URL`, and `MEMORY_EMBEDDING_MODEL` are all configured
129
+ - The Qdrant collection is auto-created on first write, and vector dimension is inferred from the first embedding response
130
+
131
+ **Recommended local memory setup (Qdrant + Nomic Embed / Infinity):**
132
+
133
+ Full Docker Compose, ports, and troubleshooting: **[docs/memory-local-setup.md](docs/memory-local-setup.md)**
134
+
135
+ ```json
136
+ {
137
+ "mcpServers": {
138
+ "mcp-probe-kit": {
139
+ "command": "npx",
140
+ "args": ["-y", "mcp-probe-kit@latest"],
141
+ "env": {
142
+ "MEMORY_QDRANT_URL": "http://127.0.0.1:50008",
143
+ "MEMORY_QDRANT_API_KEY": "your-qdrant-api-key",
144
+ "MEMORY_QDRANT_COLLECTION": "mcp_probe_memory",
145
+ "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
146
+ "MEMORY_EMBEDDING_URL": "http://127.0.0.1:50012/embeddings",
147
+ "MEMORY_EMBEDDING_MODEL": "nomic-ai/nomic-embed-text-v1.5",
148
+ "MEMORY_EMBEDDING_API_KEY": "your-infinity-api-key",
149
+ "MEMORY_SEARCH_LIMIT": "3",
150
+ "MEMORY_SUMMARY_MAX_CHARS": "280"
151
+ }
152
+ }
153
+ }
154
+ }
155
+ ```
156
+
157
+ **Alternative: Qdrant + Ollama** (if you already run Ollama):
158
+
159
+ ```bash
160
+ docker run -d --name mcp-qdrant -p 6333:6333 qdrant/qdrant
161
+ ollama pull nomic-embed-text
162
+ ```
163
+
164
+ ```json
165
+ "MEMORY_QDRANT_URL": "http://127.0.0.1:6333",
166
+ "MEMORY_EMBEDDING_PROVIDER": "ollama",
167
+ "MEMORY_EMBEDDING_URL": "http://127.0.0.1:11434/api/embeddings",
168
+ "MEMORY_EMBEDDING_MODEL": "nomic-embed-text"
169
+ ```
170
+
171
+ **OpenAI-compatible embedding (hosted API):**
172
+ ```json
173
+ {
174
+ "mcpServers": {
175
+ "mcp-probe-kit": {
176
+ "command": "npx",
177
+ "args": ["-y", "mcp-probe-kit@latest"],
178
+ "env": {
179
+ "MEMORY_QDRANT_URL": "http://127.0.0.1:6333",
180
+ "MEMORY_QDRANT_COLLECTION": "mcp_probe_memory",
181
+ "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
182
+ "MEMORY_EMBEDDING_URL": "https://your-embedding-endpoint/v1/embeddings",
183
+ "MEMORY_EMBEDDING_API_KEY": "your-api-key",
184
+ "MEMORY_EMBEDDING_MODEL": "text-embedding-3-small"
185
+ }
186
+ }
187
+ }
188
+ }
189
+ ```
190
+
191
+ ### ðŸŽŊ Structured Output
192
+
193
+ Core and orchestration tools support **structured output**, returning machine-readable JSON data, improving AI parsing accuracy, supporting tool chaining and state tracking.
194
+
195
+ ### ⏱ïļ Native Tasks, Progress, and Cancellation
196
+
197
+ - Built on MCP SDK native task support (`taskStore` + `taskMessageQueue`)
198
+ - Supports task lifecycle endpoints: `tasks/get`, `tasks/result`, `tasks/list`, `tasks/cancel`
199
+ - Advertises `capabilities.tasks.requests.tools.call` so clients can create tasks for `tools/call`
200
+ - Emits `notifications/progress` when client provides `_meta.progressToken`
201
+ - Handles request cancellation via `AbortSignal` and returns a clear cancellation error
202
+ - Long-running orchestration tools (`start_*`) and `sync_ui_data` support cooperative cancellation/progress callbacks
203
+
204
+ ### 🔌 Extensions & UI Apps (Optional)
205
+
206
+ - Trace metadata passthrough: request `_meta.trace` is preserved in tool responses (`_meta.trace`)
207
+ - Optional extensions capability switch: enable with `MCP_ENABLE_EXTENSIONS_CAPABILITY=1`
208
+ - Optional MCP Apps resource output for UI tools: enable with `MCP_ENABLE_UI_APPS=1`
209
+ - UI tools can expose preview resources via `ui://...` and response `_meta.ui.resourceUri`
210
+
211
+ ### 🧭 Delegated Orchestration Protocol
212
+
213
+ All `start_*` orchestration tools return an **execution plan** in `structuredContent.metadata.plan`.
214
+ AI needs to **call tools step by step and persist files**, rather than the tool executing internally.
215
+
216
+ **Plan Schema (Core Fields)**:
217
+ ```json
218
+ {
219
+ "mode": "delegated",
220
+ "steps": [
221
+ {
222
+ "id": "spec",
223
+ "tool": "add_feature",
224
+ "args": { "feature_name": "user-auth", "description": "User authentication feature" },
225
+ "outputs": ["docs/specs/user-auth/requirements.md"]
226
+ }
227
+ ]
228
+ }
229
+ ```
230
+
231
+ **Field Description**:
232
+ - `mode`: Fixed as `delegated`
233
+ - `steps`: Array of execution steps
234
+ - `tool`: Tool name (e.g. `add_feature`)
235
+ - `action`: Manual action description when no tool (e.g. `update_project_context`)
236
+ - `args`: Tool parameters
237
+ - `outputs`: Expected artifacts
238
+ - `when/dependsOn/note`: Optional conditions and notes
239
+
240
+ ### ðŸ§Đ Structured Output Field Specification (Key Fields)
241
+
242
+ Both orchestration and atomic tools return `structuredContent`, common fields:
243
+ - `summary`: One-line summary
244
+ - `status`: Status (pending/success/failed/partial)
245
+ - `steps`: Execution steps (orchestration tools)
246
+ - `artifacts`: Artifact list (path + purpose)
247
+ - `metadata.plan`: Delegated execution plan (only start_*)
248
+ - `specArtifacts`: Specification artifacts (start_feature)
249
+ - `estimate`: Estimation results (start_feature / estimate)
250
+
251
+ ### 🧠 Requirements Clarification Mode (Requirements Loop)
252
+
253
+ When requirements are unclear, use `requirements_mode=loop` in `start_feature / start_bugfix / start_ui`.
254
+ This mode performs 1-2 rounds of structured clarification before entering spec/fix/UI execution.
255
+
256
+ **Example:**
257
+ ```json
258
+ {
259
+ "feature_name": "user-auth",
260
+ "description": "User authentication feature",
261
+ "requirements_mode": "loop",
262
+ "loop_max_rounds": 2,
263
+ "loop_question_budget": 5
264
+ }
265
+ ```
266
+
267
+ ### ðŸ§Đ Template System (Regular Model Friendly)
268
+
269
+ `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).
270
+
271
+ **Example:**
272
+ ```json
273
+ {
274
+ "description": "Add user authentication feature",
275
+ "template_profile": "auto"
276
+ }
277
+ ```
278
+
279
+ **Applicable Tools**:
280
+ - `start_feature` passes `template_profile` to `add_feature`
281
+ - `start_bugfix` / `start_ui` also support `template_profile` for controlling guidance strength (auto/guided/strict)
282
+
283
+ **Template Profile Strategy**:
284
+ - `guided`: Less/incomplete requirements info, regular model priority
285
+ - `strict`: Requirements structured, prefer more compact guidance
286
+ - `auto`: Default recommendation, auto-selects guided/strict
287
+
288
+ ### 🔄 Workflow Orchestration
289
+
290
+ 6 intelligent orchestration tools that automatically combine multiple basic tools for one-click complex development workflows:
291
+ - `start_feature` - New feature development (Requirements → Design → Estimation)
292
+ - `start_bugfix` - Bug fixing (TBP 8-step RCA → Fix → Testing)
293
+ - `start_onboard` - Project onboarding (Generate project context docs)
294
+ - `start_ui` - UI development (Design system → Components → Code)
295
+ - `start_product` - Product design (PRD → Prototype → Design system → HTML)
296
+ - `start_ralph` - Ralph Loop (Iterative development until goal completion)
297
+
298
+ ### 🚀 Product Design Workflow
299
+
300
+ `start_product` is a complete product design orchestration tool, from requirements to interactive prototype:
301
+
302
+ **Workflow:**
303
+ 1. **Requirements Analysis** - Generate standard PRD (product overview, feature requirements, page list)
304
+ 2. **Prototype Design** - Generate detailed prototype docs for each page
305
+ 3. **Design System** - Generate design specifications based on product type
306
+ 4. **HTML Prototype** - Generate interactive prototype viewable in browser
307
+ 5. **Project Context** - Auto-update project documentation
308
+
309
+ **Structured Output Additions**:
310
+ - `start_product.structuredContent.artifacts`: Artifact list (PRD, prototypes, design system, etc.)
311
+ - `interview.structuredContent.mode`: `usage` / `questions` / `record`
312
+
313
+ ### ðŸŽĻ UI/UX Pro Max
314
+
315
+ 4 UI/UX tools with `start_ui` as the unified entry point:
316
+ - `start_ui` - One-click UI development (supports intelligent mode) (orchestration tool)
317
+ - `ui_design_system` - Intelligent design system generation
318
+ - `ui_search` - UI/UX data search (BM25 algorithm)
319
+ - `sync_ui_data` - Sync latest UI/UX data locally
320
+
321
+ **Note**: `start_ui` automatically calls `ui_design_system` and `ui_search`, you don't need to call them separately.
322
+
323
+ **Inspiration:**
324
+ - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX design system philosophy
325
+ - [json-render](https://github.com/vercel-labs/json-render) - JSON template rendering engine
326
+
327
+ **Skill Bridge for UI/PRD workflows:**
328
+ - `start_ui` and `start_product` now include a Skill Bridge section in guidance and `structuredContent.metadata.skills`.
329
+ - Recommended skill call order: `ui-ux-pro-max` → `interaction-design` → `frontend-design`.
330
+ - If some skills are missing, workflow continues with MCP main plan and marks unavailable skills in metadata.
331
+
332
+ **Why use `sync_ui_data`?**
333
+
334
+ 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:
335
+ - ðŸŽĻ Color schemes (mainstream brand colors, color palettes)
336
+ - ðŸ”Ģ Icon libraries (React Icons, Heroicons, etc.)
337
+ - 📊 Chart components (Recharts, Chart.js, etc.)
338
+ - ðŸŽŊ Landing page templates (SaaS, e-commerce, government, etc.)
339
+ - 📐 Design specifications (spacing, fonts, shadows, etc.)
340
+
341
+ **Data Sync Strategy:**
342
+ 1. **Embedded Data**: Synced at build time, works offline
343
+ 2. **Background Auto Sync**: Downloads latest data to `~/.mcp-probe-kit/ui-ux-data/` without changing current session output
344
+ 3. **Next-Start Activation**: Newly downloaded data is applied on next process start (keeps current session deterministic)
345
+ 4. **Manual Sync**: Use `sync_ui_data` to force refresh cache immediately (still applies next start by default)
346
+
347
+ This ensures `start_ui` can generate professional-grade UI code even offline.
348
+
349
+ ### ðŸŽĪ Requirements Interview
350
+
351
+ 2 interview tools to clarify requirements before development:
352
+ - `interview` - Structured requirements interview
353
+ - `ask_user` - AI proactive questioning
354
+
355
+ ---
356
+
357
+ ## 🧭 Tool Selection Guide
358
+
359
+ ### When to use orchestration tools vs individual tools?
360
+
361
+ **Use orchestration tools (start_*) when:**
362
+ - ✅ Need complete workflow (multiple steps)
363
+ - ✅ Want to automate multiple tasks
364
+ - ✅ Need to generate multiple artifacts (docs, code, tests, etc.)
365
+
366
+ **Use individual tools when:**
367
+ - ✅ Only need specific functionality
368
+ - ✅ Already have project context docs
369
+ - ✅ Need more fine-grained control
370
+
371
+ ### Common Scenario Selection
372
+
373
+ | Scenario | Recommended Tool | Reason |
374
+ |---------|-----------------|--------|
375
+ | Develop new feature (complete flow) | `start_feature` | Auto-complete: spec→estimation |
376
+ | Only need feature spec docs | `add_feature` | More lightweight, only generates docs |
377
+ | Fix bug (complete flow) | `start_bugfix` | Root-cause-first flow: TBP RCA → fix → test |
378
+ | Only need bug analysis | `fix_bug` | TBP 8-step RCA only, without full orchestration |
379
+ | Generate design system | `ui_design_system` | Directly generate design specs |
380
+ | Develop UI components | `start_ui` | Complete flow: design→components→code |
381
+ | Product design (requirements to prototype) | `start_product` | One-click: PRD→prototype→HTML |
382
+ | One-sentence requirement analysis | `init_project` | Generate complete project spec docs |
383
+ | Project onboarding docs | `init_project_context` | Generate tech stack/architecture/conventions |
384
+
385
+ ---
386
+
387
+ ## 🚀 Quick Start
388
+
389
+ ### Method 1: Use directly with npx (Recommended)
390
+
391
+ No installation needed, use the latest version directly.
392
+
393
+ #### Cursor / Cline Configuration
394
+
395
+ **Config file location:**
396
+ - Windows: `%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`
397
+ - macOS: `~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
398
+ - Linux: `~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`
399
+
400
+ **Config content:**
401
+ ```json
402
+ {
403
+ "mcpServers": {
404
+ "mcp-probe-kit": {
405
+ "command": "npx",
406
+ "args": ["mcp-probe-kit@latest"]
407
+ }
408
+ }
409
+ }
410
+ ```
411
+
412
+ #### Claude Desktop Configuration
413
+
414
+ **Config file location:**
415
+ - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
416
+ - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
417
+ - Linux: `~/.config/Claude/claude_desktop_config.json`
418
+
419
+ **Config content:**
420
+ ```json
421
+ {
422
+ "mcpServers": {
423
+ "mcp-probe-kit": {
424
+ "command": "npx",
425
+ "args": ["-y", "mcp-probe-kit@latest"]
426
+ }
427
+ }
428
+ }
429
+ ```
430
+
431
+ #### OpenCode Configuration
432
+
433
+ **Config file location:**
434
+ - Project-level: `opencode.json` (in project root)
435
+ - Global: `~/.config/opencode/opencode.json`
436
+
437
+ **Config content:**
438
+ ```json
439
+ {
440
+ "mcp": {
441
+ "mcp-probe-kit": {
442
+ "type": "local",
443
+ "command": ["npx", "-y", "mcp-probe-kit@latest"],
444
+ "enabled": true
445
+ }
446
+ }
447
+ }
448
+ ```
449
+
450
+ > **Note:** OpenCode uses `opencode.json` with a different schema from Cursor/Claude Desktop. The key `mcp` replaces `mcpServers`, `command` is an array, `type: "local"` is required, and environment variables use `environment` instead of `env`. See [OpenCode MCP docs](https://opencode.ai/docs/mcp) for details.
451
+
452
+ ### Method 2: Global Installation
453
+
454
+ ```bash
455
+ npm install -g mcp-probe-kit
456
+ ```
457
+
458
+ Use in config file:
459
+ ```json
460
+ {
461
+ "mcpServers": {
462
+ "mcp-probe-kit": {
463
+ "command": "mcp-probe-kit"
464
+ }
465
+ }
466
+ }
467
+ ```
468
+
469
+ ### Optional Memory System Setup
470
+
471
+ If you want to use `memorize_asset`, `read_memory_asset`, and `scan_and_extract_patterns`, you need both:
472
+
473
+ 1. A **Qdrant** vector database
474
+ 2. An **embedding service** in either `ollama` or `openai-compatible` mode
475
+
476
+ **Full guide (Docker Compose for Qdrant + Infinity, ports `50008` / `50012`, MCP env, smoke tests):**
477
+
478
+ - English: [docs/memory-local-setup.md](docs/memory-local-setup.md)
479
+ - äļ­æ–‡: [docs/memory-local-setup.zh-CN.md](docs/memory-local-setup.zh-CN.md)
480
+
481
+ #### Option A: Qdrant + Nomic Embed / Infinity (recommended)
482
+
483
+ Lightweight local stack; no Ollama. Deploy Qdrant and `nomic-embed` via Docker Compose (see guide), then:
484
+
485
+ ```json
486
+ {
487
+ "mcpServers": {
488
+ "mcp-probe-kit": {
489
+ "command": "npx",
490
+ "args": ["-y", "mcp-probe-kit@latest"],
491
+ "env": {
492
+ "MEMORY_QDRANT_URL": "http://127.0.0.1:50008",
493
+ "MEMORY_QDRANT_API_KEY": "your-qdrant-api-key",
494
+ "MEMORY_QDRANT_COLLECTION": "mcp_probe_memory",
495
+ "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
496
+ "MEMORY_EMBEDDING_URL": "http://127.0.0.1:50012/embeddings",
497
+ "MEMORY_EMBEDDING_MODEL": "nomic-ai/nomic-embed-text-v1.5",
498
+ "MEMORY_EMBEDDING_API_KEY": "your-infinity-api-key",
499
+ "MEMORY_SEARCH_LIMIT": "3",
500
+ "MEMORY_SUMMARY_MAX_CHARS": "280"
501
+ }
502
+ }
503
+ }
504
+ }
505
+ ```
506
+
507
+ > Embedding URL must be `/embeddings` (not `/v1/embeddings`). Qdrant requires `api-key` when `QDRANT__SERVICE__API_KEY` is set.
508
+
509
+ #### Option B: Qdrant + Ollama
510
+
511
+ ```bash
512
+ docker run -d --name mcp-qdrant -p 6333:6333 qdrant/qdrant
513
+ ollama pull nomic-embed-text
514
+ ```
515
+
516
+ ```json
517
+ "MEMORY_QDRANT_URL": "http://127.0.0.1:6333",
518
+ "MEMORY_EMBEDDING_PROVIDER": "ollama",
519
+ "MEMORY_EMBEDDING_URL": "http://127.0.0.1:11434/api/embeddings",
520
+ "MEMORY_EMBEDDING_MODEL": "nomic-embed-text"
521
+ ```
522
+
523
+ #### Option C: Qdrant + hosted OpenAI-compatible API
524
+
525
+ ```json
526
+ "MEMORY_QDRANT_URL": "http://127.0.0.1:50008",
527
+ "MEMORY_EMBEDDING_PROVIDER": "openai-compatible",
528
+ "MEMORY_EMBEDDING_URL": "https://your-embedding-endpoint/v1/embeddings",
529
+ "MEMORY_EMBEDDING_API_KEY": "your-api-key",
530
+ "MEMORY_EMBEDDING_MODEL": "text-embedding-3-small"
531
+ ```
532
+
533
+ #### Memory Environment Variables
534
+
535
+ - `MEMORY_QDRANT_URL`: Qdrant base URL, required for all memory features
536
+ - `MEMORY_QDRANT_API_KEY`: Optional Qdrant API key
537
+ - `MEMORY_QDRANT_COLLECTION`: Collection name, default `mcp_probe_memory`
538
+ - `MEMORY_EMBEDDING_PROVIDER`: `ollama` or `openai-compatible`
539
+ - `MEMORY_EMBEDDING_URL`: Embedding endpoint URL
540
+ - `MEMORY_EMBEDDING_API_KEY`: Optional for Ollama, usually required for hosted OpenAI-compatible providers
541
+ - `MEMORY_EMBEDDING_MODEL`: Default is `nomic-embed-text`
542
+ - `MEMORY_SEARCH_LIMIT`: Default search result count is `3`
543
+ - `MEMORY_SUMMARY_MAX_CHARS`: Default summary truncation length is `280`
544
+
545
+ #### Notes
546
+
547
+ - Memory write capability is enabled only when `MEMORY_QDRANT_URL`, `MEMORY_EMBEDDING_URL`, and `MEMORY_EMBEDDING_MODEL` are configured
548
+ - Memory read capability only requires `MEMORY_QDRANT_URL`
549
+ - Qdrant collections are auto-created on first write with `Cosine` distance
550
+ - Vector size is inferred from the first embedding response
551
+
552
+ ### Windows Notes for Graph Tools
553
+
554
+ Applies to `code_insight`, `start_feature`, `start_bugfix`, and `init_project_context`.
555
+
556
+ - The GitNexus bridge uses `npx -y gitnexus@latest mcp` by default.
557
+ - On Windows, the first cold start can take 20+ seconds because `npx` may check/download packages.
558
+ - Some GitNexus dependencies use `tree-sitter-*` native modules. If your machine lacks Visual Studio Build Tools, the first install may fail with errors like `gyp ERR! find VS could not find a version of Visual Studio 2017 or newer to use`.
559
+
560
+ Recommended on Windows:
561
+
562
+ 1. Install Visual Studio Build Tools with the C++ workload if you use graph-aware tools regularly.
563
+ 2. Prefer stable local/global CLI usage for GitNexus when your MCP client supports `env`.
564
+ 3. Increase GitNexus connect/call timeouts on slower or first-run environments.
565
+
566
+ Quick install command (Windows):
567
+
568
+ ```powershell
569
+ winget install Microsoft.VisualStudio.2022.BuildTools
570
+ ```
571
+
572
+ Example config using a preinstalled `gitnexus` CLI:
573
+
574
+ ```json
575
+ {
576
+ "mcpServers": {
577
+ "mcp-probe-kit": {
578
+ "command": "mcp-probe-kit",
579
+ "env": {
580
+ "MCP_GITNEXUS_COMMAND": "gitnexus",
581
+ "MCP_GITNEXUS_ARGS": "mcp",
582
+ "MCP_GITNEXUS_CONNECT_TIMEOUT_MS": "30000",
583
+ "MCP_GITNEXUS_TIMEOUT_MS": "45000"
584
+ }
585
+ }
586
+ }
587
+ }
588
+ ```
589
+
590
+ ### Restart Client
591
+
592
+ After configuration, **completely quit and reopen** your MCP client.
593
+
594
+ **👉 [Detailed Installation Guide](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
595
+
596
+ ---
597
+
598
+ ## ðŸ’Ą Usage Examples
599
+
600
+ ### Daily Development
601
+ ```bash
602
+ code_review @feature.ts # Code review
603
+ gentest @feature.ts # Generate tests
604
+ gencommit # Generate commit message
605
+ ```
606
+
607
+ ### New Feature Development
608
+ ```bash
609
+ start_feature user-auth "User authentication feature"
610
+ # Auto-complete: Requirements analysis → Design → Effort estimation
611
+ ```
612
+
613
+ ### Bug Fixing
614
+ ```bash
615
+ start_bugfix
616
+ # Then paste error message
617
+ # Auto-complete: Problem location → Fix solution → Test code
618
+ ```
619
+
620
+ ### Product Design
621
+ ```bash
622
+ start_product "Online Education Platform" --product_type=SaaS
623
+ # Auto-complete: PRD → Prototype → Design system → HTML prototype
624
+ ```
625
+
626
+ ### UI Development
627
+ ```bash
628
+ start_ui "Login Page" --mode=auto
629
+ # Auto-complete: Design system → Component generation → Code output
630
+ ```
631
+
632
+ ### Project Context Documentation
633
+ ```bash
634
+ # Single file mode (default) - Generate a complete project-context.md
635
+ init_project_context
636
+
637
+ # Modular mode - Generate 6 category docs (suitable for large projects)
638
+ init_project_context --mode=modular
639
+ # Generates: project-context.md (index) + 5 category docs
640
+ ```
641
+
642
+ ### Git Work Report
643
+ ```bash
644
+ # Generate daily report
645
+ git_work_report --date 2026-02-03
646
+
647
+ # Generate weekly report
648
+ git_work_report --start_date 2026-02-01 --end_date 2026-02-07
649
+
650
+ # Save to file
651
+ git_work_report --date 2026-02-03 --output_file daily-report.md
652
+ # Auto-analyze Git diff, generate concise professional report
653
+ # If direct command fails, auto-provides temp script solution (auto-deletes after execution)
654
+ ```
655
+
656
+ **👉 [More Usage Examples](https://mcp-probe-kit.bytezonex.com/pages/examples.html)**
657
+
658
+ ---
659
+
660
+ ## ❓ FAQ
661
+
662
+ ### Q1: Tool not working or errors?
663
+
664
+ Check detailed logs:
665
+
666
+ **Windows (PowerShell):**
667
+ ```powershell
668
+ npx -y mcp-probe-kit@latest 2>&1 | Tee-Object -FilePath .\mcp-probe-kit.log
669
+ ```
670
+
671
+ **macOS/Linux:**
672
+ ```bash
673
+ npx -y mcp-probe-kit@latest 2>&1 | tee ./mcp-probe-kit.log
674
+ ```
675
+
676
+ ### Q2: Client not recognizing tools after configuration?
677
+
678
+ 1. **Restart client** (completely quit then reopen)
679
+ 2. Check config file path is correct
680
+ 3. Confirm JSON format is correct, no syntax errors
681
+ 4. Check client developer tools or logs for error messages
682
+
683
+ ### Q3: How to update to latest version?
684
+
685
+ **npx method (Recommended):**
686
+ Use `@latest` tag in config, automatically uses latest version.
687
+
688
+ **Global installation method:**
689
+ ```bash
690
+ npm update -g mcp-probe-kit
691
+ ```
692
+
693
+ ### Q4: Why are graph-aware tools slow or timing out on Windows the first time?
694
+
695
+ This usually affects `code_insight`, `start_feature`, `start_bugfix`, and `init_project_context`.
696
+
697
+ Common causes:
698
+
699
+ 1. `npx -y gitnexus@latest mcp` performs a cold start and may spend 20+ seconds checking/downloading packages.
700
+ 2. GitNexus may need native `tree-sitter-*` modules, which can require Visual Studio Build Tools on Windows.
701
+
702
+ If you see logs like:
703
+
704
+ ```text
705
+ gyp ERR! find VS could not find a version of Visual Studio 2017 or newer to use
706
+ gyp ERR! find VS - missing any VC++ toolset
707
+ ```
708
+
709
+ Try this:
710
+
711
+ 1. Install Visual Studio Build Tools with the C++ workload.
712
+ 2. Retry once after dependencies finish installing.
713
+ 3. If your client supports `env`, switch the bridge to a preinstalled `gitnexus` CLI and raise:
714
+ `MCP_GITNEXUS_CONNECT_TIMEOUT_MS`
715
+ `MCP_GITNEXUS_TIMEOUT_MS`
716
+
717
+ **👉 [More FAQ](https://mcp-probe-kit.bytezonex.com/pages/getting-started.html)**
718
+
719
+ ---
720
+
721
+ ## ðŸĪ Contributing
722
+
723
+ Issues and Pull Requests welcome!
724
+
725
+ **Improvement suggestions:**
726
+ - Add useful tools
727
+ - Optimize existing tool prompts
728
+ - Improve documentation and examples
729
+ - Fix bugs
730
+
731
+ ---
732
+
733
+ ## 📄 License
734
+
735
+ MIT License
736
+
737
+ ---
738
+
739
+ ## 🔗 Related Links
740
+
741
+ - **Author**: [Kyle (小åĒĻ)](https://www.bytezonex.com/)
742
+ - **GitHub**: [mcp-probe-kit](https://github.com/mybolide/mcp-probe-kit)
743
+ - **npm**: [mcp-probe-kit](https://www.npmjs.com/package/mcp-probe-kit)
744
+ - **Documentation**: [https://mcp-probe-kit.bytezonex.com](https://mcp-probe-kit.bytezonex.com/)
745
+
746
+ **Related Projects:**
747
+ - [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) - Official MCP protocol docs
748
+ - [GitHub Spec-Kit](https://github.com/github/spec-kit) - GitHub spec-driven development toolkit
749
+ - [ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - UI/UX design system philosophy source
750
+ - [json-render](https://github.com/vercel-labs/json-render) - JSON template rendering engine inspiration
751
+ - [uipro-cli](https://www.npmjs.com/package/uipro-cli) - UI/UX data source
752
+
753
+ ---
754
+
755
+ **Made with âĪïļ for AI-Powered Development**