mcp-probe-kit 3.0.23 → 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 (141) hide show
  1. package/README.md +755 -779
  2. package/build/index.js +38 -40
  3. package/build/lib/__tests__/memory-injection.unit.test.js +1 -0
  4. package/build/lib/agents-md-template.js +32 -32
  5. package/build/lib/memory-client.d.ts +2 -0
  6. package/build/lib/memory-client.js +1 -0
  7. package/build/lib/memory-config.d.ts +2 -0
  8. package/build/lib/memory-config.js +1 -0
  9. package/build/lib/memory-orchestration.d.ts +4 -0
  10. package/build/lib/memory-orchestration.js +28 -5
  11. package/build/lib/skill-bridge.js +12 -12
  12. package/build/resources/index.d.ts +4 -0
  13. package/build/resources/index.js +4 -0
  14. package/build/resources/tool-params-guide.d.ts +571 -0
  15. package/build/resources/tool-params-guide.js +488 -0
  16. package/build/resources/ui-ux-data/guidelines/vercel-web-interface.json +1632 -1632
  17. package/build/resources/ui-ux-data/metadata.json +30 -30
  18. package/build/resources/ui-ux-data/shadcn/blocks.json +2541 -2541
  19. package/build/resources/ui-ux-data/shadcn/components.json +997 -997
  20. package/build/resources/ui-ux-data/themes/presets.json +483 -483
  21. package/build/schemas/index.d.ts +0 -22
  22. package/build/schemas/memory-tools.d.ts +0 -22
  23. package/build/schemas/memory-tools.js +0 -14
  24. package/build/tools/__tests__/read_memory_asset.unit.test.js +75 -0
  25. package/build/tools/__tests__/search_memory.unit.test.js +7 -1
  26. package/build/tools/analyze_project.d.ts +1 -0
  27. package/build/tools/analyze_project.js +527 -0
  28. package/build/tools/check_deps.d.ts +13 -0
  29. package/build/tools/check_deps.js +204 -0
  30. package/build/tools/code_insight.js +41 -41
  31. package/build/tools/convert.d.ts +13 -0
  32. package/build/tools/convert.js +599 -0
  33. package/build/tools/css_order.d.ts +13 -0
  34. package/build/tools/css_order.js +81 -0
  35. package/build/tools/debug.d.ts +13 -0
  36. package/build/tools/debug.js +131 -0
  37. package/build/tools/design2code.d.ts +20 -0
  38. package/build/tools/design2code.js +426 -0
  39. package/build/tools/detect_shell.d.ts +6 -0
  40. package/build/tools/detect_shell.js +151 -0
  41. package/build/tools/explain.d.ts +13 -0
  42. package/build/tools/explain.js +390 -0
  43. package/build/tools/fix.d.ts +13 -0
  44. package/build/tools/fix.js +303 -0
  45. package/build/tools/fix_bug.js +161 -161
  46. package/build/tools/gen_mock.d.ts +22 -0
  47. package/build/tools/gen_mock.js +269 -0
  48. package/build/tools/gen_skill.d.ts +13 -0
  49. package/build/tools/gen_skill.js +560 -0
  50. package/build/tools/genapi.d.ts +13 -0
  51. package/build/tools/genapi.js +174 -0
  52. package/build/tools/genchangelog.d.ts +13 -0
  53. package/build/tools/genchangelog.js +250 -0
  54. package/build/tools/gencommit.js +60 -60
  55. package/build/tools/gendoc.d.ts +13 -0
  56. package/build/tools/gendoc.js +232 -0
  57. package/build/tools/genpr.d.ts +13 -0
  58. package/build/tools/genpr.js +194 -0
  59. package/build/tools/genreadme.d.ts +13 -0
  60. package/build/tools/genreadme.js +626 -0
  61. package/build/tools/gensql.d.ts +13 -0
  62. package/build/tools/gensql.js +320 -0
  63. package/build/tools/genui.d.ts +13 -0
  64. package/build/tools/genui.js +803 -0
  65. package/build/tools/index.d.ts +0 -1
  66. package/build/tools/index.js +0 -1
  67. package/build/tools/init_component_catalog.d.ts +22 -0
  68. package/build/tools/init_component_catalog.js +809 -0
  69. package/build/tools/init_project_context.js +432 -432
  70. package/build/tools/init_setting.d.ts +13 -0
  71. package/build/tools/init_setting.js +47 -0
  72. package/build/tools/perf.d.ts +13 -0
  73. package/build/tools/perf.js +409 -0
  74. package/build/tools/read_memory_asset.js +2 -1
  75. package/build/tools/render_ui.d.ts +22 -0
  76. package/build/tools/render_ui.js +384 -0
  77. package/build/tools/resolve_conflict.d.ts +13 -0
  78. package/build/tools/resolve_conflict.js +349 -0
  79. package/build/tools/search_memory.js +1 -0
  80. package/build/tools/security_scan.d.ts +22 -0
  81. package/build/tools/security_scan.js +323 -0
  82. package/build/tools/split.d.ts +13 -0
  83. package/build/tools/split.js +599 -0
  84. package/build/tools/start_api.d.ts +13 -0
  85. package/build/tools/start_api.js +193 -0
  86. package/build/tools/start_bugfix.js +233 -233
  87. package/build/tools/start_doc.d.ts +13 -0
  88. package/build/tools/start_doc.js +207 -0
  89. package/build/tools/start_feature.js +117 -117
  90. package/build/tools/start_product.js +1 -1
  91. package/build/tools/start_refactor.d.ts +13 -0
  92. package/build/tools/start_refactor.js +188 -0
  93. package/build/tools/start_release.d.ts +13 -0
  94. package/build/tools/start_release.js +167 -0
  95. package/build/tools/start_review.d.ts +13 -0
  96. package/build/tools/start_review.js +175 -0
  97. package/build/tools/start_ui.js +399 -399
  98. package/build/tools/ui-ux-tools.js +290 -290
  99. package/build/utils/__tests__/vercel-guidelines-sync.unit.test.js +12 -12
  100. package/build/utils/themes-sync.js +8 -8
  101. package/package.json +81 -83
  102. package/build/lib/__tests__/memory-orchestration.unit.test.js +0 -84
  103. package/build/lib/__tests__/memory-payload.unit.test.js +0 -35
  104. package/build/lib/cursor-history-client.d.ts +0 -54
  105. package/build/lib/cursor-history-client.js +0 -240
  106. package/build/tools/__tests__/cursor-history.unit.test.js +0 -38
  107. package/build/tools/cursor_read_conversation.d.ts +0 -7
  108. package/build/tools/cursor_read_conversation.js +0 -36
  109. package/docs/.mcp-probe/layout.json +0 -11
  110. package/docs/CNAME +0 -1
  111. package/docs/assets/font/MaterialSymbolsOutlined.codepoints +0 -4102
  112. package/docs/assets/font/MaterialSymbolsOutlined.ttf +0 -0
  113. package/docs/assets/font/noto-sans-sc-400.ttf +0 -0
  114. package/docs/assets/font/noto-sans-sc-700.ttf +0 -0
  115. package/docs/assets/font/noto-sans-sc-900.ttf +0 -0
  116. package/docs/assets/js/i18n.js +0 -375
  117. package/docs/assets/js/tailwind.js +0 -83
  118. package/docs/assets/logo-zh.png +0 -0
  119. package/docs/assets/logo.png +0 -0
  120. package/docs/data/tools.js +0 -523
  121. package/docs/i18n/all-tools/en.json +0 -190
  122. package/docs/i18n/all-tools/ja.json +0 -171
  123. package/docs/i18n/all-tools/ko.json +0 -171
  124. package/docs/i18n/all-tools/zh-CN.json +0 -190
  125. package/docs/i18n/en.json +0 -626
  126. package/docs/i18n/ja.json +0 -602
  127. package/docs/i18n/ko.json +0 -602
  128. package/docs/i18n/zh-CN.json +0 -626
  129. package/docs/index.html +0 -327
  130. package/docs/memory-local-setup.md +0 -314
  131. package/docs/memory-local-setup.zh-CN.md +0 -283
  132. package/docs/pages/all-tools.html +0 -515
  133. package/docs/pages/examples.html +0 -717
  134. package/docs/pages/getting-started.html +0 -964
  135. package/docs/pages/migration.html +0 -308
  136. package/docs/specs/user-auth/design.md +0 -82
  137. package/docs/specs/user-auth/requirements.md +0 -52
  138. package/docs/specs/user-auth/tasks.md +0 -55
  139. /package/build/{lib/__tests__/memory-orchestration.unit.test.d.ts → tools/__tests__/read_memory_asset.unit.test.d.ts} +0 -0
  140. /package/build/{lib/__tests__/memory-payload.unit.test.d.ts → utils/design-docs-generator.d.ts} +0 -0
  141. /package/build/{tools/__tests__/cursor-history.unit.test.d.ts → utils/design-docs-generator.js} +0 -0
package/docs/i18n/en.json DELETED
@@ -1,626 +0,0 @@
1
- {
2
- "meta": {
3
- "title": "MCP Probe Kit - AI-Powered Complete Development Toolkit | 27 Tools Covering Entire Development Lifecycle",
4
- "description": "MCP Probe Kit provides 27 AI-powered development tools covering requirements analysis, code development, quality assurance, bug fixing, and release management. Supports Cursor, Cline, Claude Desktop with 100% structured output.",
5
- "keywords": "MCP Probe Kit, AI development tools, code generation, code review, Git tools, UI development, development efficiency, Cursor, Cline, Claude, MCP Server"
6
- },
7
- "nav": {
8
- "home": "Documentation",
9
- "docs": "Docs",
10
- "mainSite": "Main Site",
11
- "github": "GitHub",
12
- "npm": "npm"
13
- },
14
- "hero": {
15
- "title": "🚀 MCP Probe Kit",
16
- "subtitle": "AI Development Enhancement Toolkit · Documentation Center",
17
- "version": "v3.0.23",
18
- "quickStart": "Quick Start",
19
- "visitMainSite": "Visit ByteZoneX"
20
- },
21
- "sections": {
22
- "quickStart": {
23
- "title": "Quick Start",
24
- "description": "Get started with MCP Probe Kit v3.0.23 in 5 minutes",
25
- "installConfig": "Installation & Configuration"
26
- },
27
- "tools": {
28
- "title": "Tools Documentation",
29
- "description": "Complete reference for 27 practical tools, including code graph insight and orchestration workflows",
30
- "allTools": "All Tools"
31
- },
32
- "guides": {
33
- "title": "Guides",
34
- "description": "Migration guides and best practices",
35
- "migration": "v2.x → v3.0 Migration Guide",
36
- "bestPractices": "Best Practices"
37
- },
38
- "resources": {
39
- "title": "Resources",
40
- "description": "Source code and community support",
41
- "mainSite": "ByteZoneX Main Site",
42
- "githubRepo": "GitHub Repository",
43
- "npmPackage": "npm Package",
44
- "issues": "Issue Tracker"
45
- }
46
- },
47
- "footer": {
48
- "madeWith": "Made with ❤️ by",
49
- "license": "MIT License",
50
- "mainSite": "Main Site ByteZoneX"
51
- },
52
- "sidebar": {
53
- "quickStart": "Quick Start",
54
- "home": "Documentation Home",
55
- "installation": "Installation & Configuration",
56
- "toolsDocs": "Tools Documentation",
57
- "allTools": "All Tools",
58
- "guides": "Guides",
59
- "migration": "Migration Guide",
60
- "examples": "Best Practices",
61
- "followUs": "Follow Us",
62
- "getTechSharing": "Get More Tech Insights"
63
- },
64
- "gettingStarted": {
65
- "title": "Installation & Configuration",
66
- "subtitle": "Get started with MCP Probe Kit v3.0.23 in 5 minutes. Supports Cursor, Cline, and Claude Desktop",
67
- "breadcrumb": {
68
- "home": "Documentation",
69
- "quickStart": "Quick Start",
70
- "installation": "Installation"
71
- },
72
- "step1": {
73
- "title": "Choose Installation Method",
74
- "npx": {
75
- "title": "Use npx Directly",
76
- "recommended": "Recommended",
77
- "description": "No installation required, use the latest version directly:",
78
- "advantage": "Advantage:",
79
- "advantageText": "No manual updates needed, automatically uses the latest version on each startup",
80
- "copy": "Copy"
81
- },
82
- "global": {
83
- "title": "Global Installation",
84
- "description": "Install globally to system:",
85
- "configFile": "Configuration file:",
86
- "note": "Note:",
87
- "noteText": "Need to manually run",
88
- "updateText": "to update version"
89
- },
90
- "memory": {
91
- "title": "Memory System Setup (Qdrant + Embedding)",
92
- "descriptionPrefix": "If you want to use",
93
- "descriptionSuffix": ", you need to configure both a vector database and an embedding service.",
94
- "guideLink": "Extended guide (troubleshooting, performance):",
95
- "guidePath": "docs/memory-local-setup.md",
96
- "deployIntro": "Copy the files below into two folders, start both services, then paste the MCP config. No Ollama required.",
97
- "portTitle": "Ports",
98
- "layoutTitle": "0. Directory layout",
99
- "layoutText": "Create two folders anywhere on your machine (example: ~/mcp-memory/):",
100
- "qdrantTitle": "1. Qdrant (vector DB, port 50008)",
101
- "qdrantCompose": "qdrant/docker-compose.yml",
102
- "qdrantEnv": "qdrant/.env",
103
- "qdrantDeploy": "Start Qdrant",
104
- "qdrantVerify": "Verify Qdrant",
105
- "qdrantNote": "When API key is enabled, all requests need header api-key. Dashboard: http://127.0.0.1:50008/dashboard",
106
- "nomicTitle": "2. Nomic Embed / Infinity (embeddings, port 50012)",
107
- "nomicCompose": "nomic-embed/docker-compose.yml",
108
- "nomicEnv": "nomic-embed/.env",
109
- "nomicDeploy": "Start embedding service",
110
- "nomicVerify": "Verify embeddings",
111
- "nomicNote": "First start downloads the model (~2–5 min). Use POST /embeddings (not /v1/embeddings). Returns 768-dim vectors.",
112
- "mcpTitle": "3. MCP client configuration",
113
- "mcpNote": "Use the same keys as in qdrant/.env and nomic-embed/.env. Restart Cursor after saving.",
114
- "alternativesTitle": "Other embedding options",
115
- "optionA": {
116
- "title": "Recommended stack (steps above)"
117
- },
118
- "optionB": {
119
- "title": "Option B: Qdrant + Ollama"
120
- },
121
- "optionC": {
122
- "title": "Option C: Qdrant + hosted OpenAI-compatible API"
123
- },
124
- "env": {
125
- "title": "Environment Variables",
126
- "item1": ": Qdrant endpoint, required by all memory features",
127
- "item2": ": Optional Qdrant API key",
128
- "item3": ": Collection name, default ",
129
- "item4Prefix": ": ",
130
- "item4Middle": " or ",
131
- "item5": ": Embedding API endpoint",
132
- "item6": ": Embedding API key, usually empty for Ollama",
133
- "item7Prefix": ": Embedding model name, default ",
134
- "item8Prefix": ": Default search result limit, default ",
135
- "item9Prefix": ": Summary max characters, default "
136
- },
137
- "behavior": {
138
- "title": "Behavior Notes",
139
- "item1Prefix": "Memory writes require ",
140
- "item1Middle": " and ",
141
- "item2Prefix": "Read-only memory access (such as read by ID) only requires ",
142
- "item3Prefix": "The first write auto-creates the Qdrant collection and uses ",
143
- "item4": "Vector dimension is inferred automatically from the first embedding response"
144
- },
145
- "cursor": {
146
- "title": "Cursor History Tools",
147
- "item1": " do not depend on Qdrant or embeddings",
148
- "item2": "Supports local Cursor installations on Windows / macOS / Linux",
149
- "item3Prefix": "Reads the local Cursor database from "
150
- }
151
- },
152
- "windowsGraph": {
153
- "title": "Windows Notes for Graph Tools",
154
- "description": "Graph-aware tools may have a slower first run on Windows because GitNexus is started through npx by default.",
155
- "item1": "The first cold start may take 20+ seconds while npx checks or downloads dependencies.",
156
- "item2": "Some GitNexus dependencies use tree-sitter native modules and may require Visual Studio Build Tools.",
157
- "item3": "If your MCP client supports env, prefer a preinstalled gitnexus CLI and raise GitNexus timeouts.",
158
- "item4": "Quick install Build Tools on Windows: winget install Microsoft.VisualStudio.2022.BuildTools",
159
- "quickInstallTitle": "Quick install command:",
160
- "exampleTitle": "Example using a preinstalled gitnexus CLI:"
161
- },
162
- "source": {
163
- "title": "Build from Source",
164
- "description": "Build from source code, suitable for developers:",
165
- "step1": "1. Clone repository",
166
- "step2": "2. Install dependencies and build",
167
- "step3": "3. Configuration file",
168
- "tip": "Tip:",
169
- "tipText": "Windows users should use full path, e.g.",
170
- "note": "Note:",
171
- "noteText": "After modifying code, need to re-run",
172
- "compileText": "to compile"
173
- }
174
- },
175
- "step2": {
176
- "title": "Locate Configuration File",
177
- "description": "Find the corresponding configuration file based on your MCP client:",
178
- "cursor": {
179
- "title": "Cursor / Cline",
180
- "description": "Create or edit in project root directory",
181
- "tip": "Tip:",
182
- "tipText": "Cursor and Cline use project-level configuration, each project can have independent MCP server configuration."
183
- },
184
- "claudeWin": {
185
- "title": "Claude Desktop (Windows)",
186
- "path": "Configuration file path:",
187
- "example": "Example:"
188
- },
189
- "claudeMac": {
190
- "title": "Claude Desktop (macOS)",
191
- "path": "Configuration file path:"
192
- },
193
- "opencode": {
194
- "title": "OpenCode",
195
- "description": "Create or edit",
196
- "description2": "in project root, or globally at",
197
- "note": "Note:",
198
- "noteText": "OpenCode uses <code>\"environment\"</code> (not <code>\"env\"</code>) for env vars, <code>\"mcp\"</code> (not <code>\"mcpServers\"</code>), and <code>\"command\"</code> as an array with <code>\"type\": \"local\"</code> required. See <a href=\"https://opencode.ai/docs/mcp\" target=\"_blank\" rel=\"noopener\" class=\"text-primary hover:underline\">OpenCode MCP docs</a>."
199
- }
200
- },
201
- "step3": {
202
- "title": "Verify Installation",
203
- "description": "After completing configuration, verify with the following steps:",
204
- "step1": "Restart MCP client (Cursor / Cline / Claude Desktop)",
205
- "step2": "Type in chat window:",
206
- "step2Command": "Please use gencommit tool to generate a test commit message",
207
- "step3": "If it returns a commit message following Conventional Commits specification, installation is successful!",
208
- "success": "Success example:",
209
- "successText": "AI returns something like",
210
- "successExample": "message",
211
- "successCode": "feat: add user authentication",
212
- "issues": "Common issues:",
213
- "issue1": "\"Tool not found\" → Check configuration file format",
214
- "issue2": "\"Command not found\" → Confirm Node.js is installed",
215
- "issue3": "Windows users → Ensure using npx method"
216
- },
217
- "step4": {
218
- "title": "Delegated Orchestration Protocol",
219
- "description": "orchestration tools do not execute operations directly, but return an executable plan.",
220
- "keyFields": "Key fields:",
221
- "planExample": "Plan Example",
222
- "tip": "Key point:",
223
- "tipText": "Execute",
224
- "tipText2": "in order, and ensure",
225
- "tipText3": "files are actually written to disk"
226
- },
227
- "faq": {
228
- "title": "⚠️ Common Issues",
229
- "q1": {
230
- "title": "Issue 1: Module resolution error caused by npx cache",
231
- "error": "Error message:",
232
- "solution": "Solution:",
233
- "solutionText": "Clear npx cache",
234
- "restart": "Then restart MCP client"
235
- },
236
- "q2": {
237
- "title": "Issue 2: MCP server connection failed",
238
- "possibleReasons": "Possible reasons:",
239
- "reason1": "Node.js version too low (requires >= 16.0.0)",
240
- "reason2": "Dependencies not installed or corrupted",
241
- "reason3": "Configuration file format error",
242
- "solution": "Solution:",
243
- "step1": "Check Node.js version:",
244
- "step2": "If below v16, please upgrade Node.js",
245
- "step3": "Clear cache and reinstall:",
246
- "step4": "Check if configuration file JSON format is correct"
247
- },
248
- "q3": {
249
- "title": "Issue 3: Graph-aware tools are slow or time out on first run on Windows",
250
- "affected": "Affected tools:",
251
- "error": "Typical error:",
252
- "reasons": "Common causes:",
253
- "reason1": "`npx -y gitnexus@latest mcp` may spend 20+ seconds checking or downloading dependencies on cold start.",
254
- "reason2": "GitNexus depends on tree-sitter native modules, which may require Visual Studio Build Tools on Windows.",
255
- "solution": "Recommended actions:",
256
- "step1": "Install Visual Studio Build Tools with the C++ workload.",
257
- "step2": "Retry once after dependencies finish installing so the first cold start is not mistaken for steady-state latency.",
258
- "step3": "If your client supports env, prefer a preinstalled gitnexus CLI and raise MCP_GITNEXUS_CONNECT_TIMEOUT_MS plus MCP_GITNEXUS_TIMEOUT_MS."
259
- }
260
- },
261
- "common": {
262
- "copy": "Copy",
263
- "copied": "Copied"
264
- }
265
- },
266
- "migration": {
267
- "breadcrumb": {
268
- "home": "Documentation",
269
- "guides": "Guides",
270
- "migration": "Migration Guide"
271
- },
272
- "title": "v3.0 Migration Guide",
273
- "subtitle": "Smoothly migrate from v2.x to v3.0, understand breaking changes and new features",
274
- "overview": {
275
- "title": "Overview",
276
- "description": "MCP Probe Kit v3.0 is a major version update, streamlined to 27 tools, bringing more powerful features and better development experience.",
277
- "migrationTime": "Migration Time:",
278
- "migrationTimeText": "Most projects can complete migration in 10-15 minutes, v2.x core tools remain compatible in v3.0."
279
- },
280
- "changes": {
281
- "title": "Major Changes",
282
- "toolsOptimization": {
283
- "title": "1. Tools Streamlining",
284
- "description": "v2.x: 39 tools → v3.x: 27 tools (removed low-frequency tools, kept high-value tools)"
285
- },
286
- "workflows": {
287
- "title": "2. New Workflow Orchestration",
288
- "description": "11",
289
- "description2": "workflow orchestration tools, providing end-to-end automated development process:",
290
- "startFeature": "Feature development workflow",
291
- "startBugfix": "Bug fix workflow",
292
- "startUi": "UI development workflow",
293
- "startProduct": "Product design workflow",
294
- "startRalph": "Ralph Loop automated development"
295
- },
296
- "uiTools": {
297
- "title": "3. New UI/UX Toolset",
298
- "description": "Complete UI/UX toolchain:",
299
- "designSystem": "Intelligent design system generator",
300
- "uiSearch": "UI/UX database search",
301
- "syncUiData": "UI/UX data synchronization",
302
- "componentCatalog": "Component catalog initialization",
303
- "renderUi": "UI rendering engine"
304
- },
305
- "codeInsight": {
306
- "title": "4. New Code Graph Insight",
307
- "description": "code_insight maintains baseline graph docs under docs/graph-insights, while start_feature/start_bugfix refresh the GitNexus index and run task-level narrowing before planning."
308
- },
309
- "structuredOutput": {
310
- "title": "5. Structured Output Upgrade",
311
- "description": "Core and orchestration tools prioritize structured output, consistent and predictable output format, facilitating tool chaining and state tracking."
312
- }
313
- },
314
- "steps": {
315
- "title": "Migration Steps",
316
- "step1": {
317
- "title": "Step 1: Update Version",
318
- "npxNote": "# If using npx (recommended)",
319
- "npxDesc": "# No action needed, automatically uses latest version",
320
- "globalNote": "# If globally installed"
321
- },
322
- "step2": {
323
- "title": "Step 2: Check Configuration File",
324
- "description": "v3.0 configuration file format is fully compatible with v2.x, no modification needed.",
325
- "compatible": "Backward Compatible:",
326
- "compatibleText": "v2.x core tools remain compatible in v3.0, seamless upgrade possible."
327
- }
328
- },
329
- "help": {
330
- "title": "Get Help",
331
- "description": "If you encounter problems during migration:",
332
- "viewDocs": "View",
333
- "toolsReference": "Complete Tools Reference",
334
- "askIn": "Ask in",
335
- "askQuestion": "ask questions",
336
- "reportIn": "Report in",
337
- "reportBug": "report bugs"
338
- },
339
- "complete": {
340
- "title": "🎉 Migration Complete!",
341
- "description": "Start exploring v3.0's powerful features",
342
- "viewTools": "View All Tools",
343
- "learnBestPractices": "Learn Best Practices"
344
- }
345
- },
346
- "examples": {
347
- "breadcrumb": {
348
- "home": "Documentation",
349
- "guides": "Guides",
350
- "examples": "Best Practices"
351
- },
352
- "title": "Best Practices",
353
- "subtitle": "MCP Probe Kit integrates complete development process, best practices guide from requirements to deployment",
354
- "overview": {
355
- "title": "Complete Development Process",
356
- "description": "MCP Probe Kit's 27 tools cover the complete development process from requirements analysis to code deployment. Here are the recommended best practices.",
357
- "coreIdea": "Core Philosophy:",
358
- "coreIdeaText": "Chain the entire development process through workflow orchestration tools (start_*), making AI your development assistant."
359
- },
360
- "stage0": {
361
- "title": "Stage 0: Product Design (From Requirements to Prototype)",
362
- "workflow": {
363
- "title": "0.1 Complete Product Design Workflow (Recommended)",
364
- "description": "Use",
365
- "description2": "workflow orchestration to complete the entire product design from requirements to HTML prototype with one click.",
366
- "example1": "You: I have a product requirements document project.md, help me generate complete product design",
367
- "productName": "Online Education Platform",
368
- "autoExecute": "→ Auto Execute:",
369
- "autoLoop": "→ AI Auto Loop:",
370
- "step1": "✓ Step 1: Check/Generate Project Context",
371
- "step2": "✓ Step 2: Generate PRD Document",
372
- "step3": "✓ Step 3: Generate Prototype Design Document",
373
- "step4": "✓ Step 4: Generate Design System",
374
- "step5": "→ Step 5: Generate HTML Interactive Prototype",
375
- "step6": "✓ Step 6: Update Project Context Index",
376
- "outputs": "→ Output Files:"
377
- },
378
- "prd": {
379
- "title": "0.2 Generate PRD Document Separately",
380
- "description": "Use",
381
- "description2": "tool to generate product requirements document separately.",
382
- "example1": "You: Generate a PRD for an online education platform",
383
- "description3": "Online education platform with course management, video playback, and assignment submission",
384
- "aiCreate": "→ AI creates docs/prd/product-requirements.md based on guidance",
385
- "includes": "PRD includes:",
386
- "item1": "- Product Overview (vision, target users, core value)",
387
- "item2": "- Functional Requirements (core features, user stories)",
388
- "item3": "- Feature Priority (P0/P1/P2)",
389
- "item4": "- Non-functional Requirements (performance, security, compatibility)",
390
- "item5": "- Page List"
391
- },
392
- "prototype": {
393
- "title": "0.3 Generate HTML Interactive Prototype",
394
- "description": "Use",
395
- "description2": "tool to generate HTML prototype based on prototype documents.",
396
- "desc": "Generate HTML prototypes for all pages based on prototype documents",
397
- "step1": "✓ Read all prototype documents under docs/prototype/",
398
- "step2": "✓ Read docs/design-system.json to get design specifications",
399
- "step3": "✓ Generate HTML files for each page",
400
- "step4": "✓ Generate index page index.html",
401
- "features": "→ Features:",
402
- "feature1": "- Uses design system colors and fonts",
403
- "feature2": "- Includes page navigation",
404
- "feature3": "- Responsive design"
405
- },
406
- "summary": {
407
- "title": "0.4 Product Design Workflow Summary",
408
- "recommended": "Recommended Process:",
409
- "step1": "Prepare requirements document (Markdown format)",
410
- "step2": "Use",
411
- "step2b": "to generate complete product design with one click",
412
- "step3": "View HTML prototype in browser",
413
- "step4": "Review prototype with team and collect feedback",
414
- "step5": "Adjust prototype documents based on feedback",
415
- "step6": "Use",
416
- "step6b": "to regenerate HTML prototype",
417
- "step7": "Proceed to development phase after confirmation"
418
- }
419
- },
420
- "stage1": {
421
- "title": "Stage 1: Requirements Analysis and Planning",
422
- "init": {
423
- "title": "1.1 New Project Initialization",
424
- "description": "Use",
425
- "description2": "to generate project documents following Spec-Driven Development approach.",
426
- "example1": "You: I want to create a task management system",
427
- "input": "Task management system with task creation, assignment, tracking, and reminders",
428
- "generate": "→ Generate: Requirements document, design document, task list"
429
- },
430
- "interview": {
431
- "title": "1.2 Requirements Clarification (Avoid Misunderstandings)",
432
- "description": "Use",
433
- "description2": "tool for structured requirements interviews.",
434
- "example1": "You: Add user login functionality",
435
- "desc": "Implement user login functionality",
436
- "aiAsk": "→ AI will ask:",
437
- "q1": "- Which login methods are supported? (Email/Phone/Third-party)",
438
- "q2": "- Do you need to remember login status?",
439
- "q3": "- What are the password rules?",
440
- "q4": "- Do you need verification code?",
441
- "generate": "→ Generate: Interview record document"
442
- },
443
- "estimate": {
444
- "title": "1.3 Workload Estimation",
445
- "description": "Use",
446
- "description2": "tool to estimate development time and resources.",
447
- "task": "Implement user authentication functionality",
448
- "output": "→ Output:",
449
- "sp": "- Story Points: 8 SP",
450
- "time": "- Time Range: Optimistic 3 days / Normal 5 days / Pessimistic 8 days",
451
- "risk": "- Risk: Third-party login integration may be delayed"
452
- },
453
- "codeInsight": {
454
- "title": "1.4 Existing Code Graph Insight",
455
- "description": "Use",
456
- "description2": "to refresh the GitNexus index, persist baseline graph docs, and produce task-level call-chain/context/impact analysis.",
457
- "example1": "You: Analyze the login and token refresh call chain and tell me which modules will be affected",
458
- "goal": "Find the existing login and token refresh flow",
459
- "taskContext": "Preparing to modify the auth module",
460
- "output": "→ Output:",
461
- "item1": "- Related execution flows / call chains",
462
- "item2": "- Key symbols and file locations",
463
- "item3": "- _meta.graph.snapshotUri / markdownFilePath",
464
- "item4": "- docs/graph-insights/latest.* and project-context index entries for downstream workflows"
465
- }
466
- },
467
- "common": {
468
- "bestPractice": "Best Practice"
469
- },
470
- "stage2": {
471
- "title": "Stage 2: Feature Development",
472
- "workflow": {
473
- "title": "2.1 Complete Feature Development Workflow (Recommended)",
474
- "description": "Use",
475
- "description2": "workflow orchestration to complete from spec to estimation with one click.",
476
- "example1": "You: Develop user authentication feature",
477
- "step1": "✓ Check project context, bootstrap missing graph docs, and refresh the GitNexus index",
478
- "step2": "✓ Generate feature specification document",
479
- "step3": "✓ Estimate development workload",
480
- "step4": "✓ Output complete development plan"
481
- },
482
- "ui": {
483
- "title": "2.2 UI Development Workflow",
484
- "description": "Use",
485
- "description2": "workflow, from design system to code in one go.",
486
- "example1": "You: Create login page",
487
- "step1": "✓ Check/generate design system",
488
- "step2": "✓ Initialize component directory",
489
- "step3": "✓ Search/generate UI template",
490
- "step4": "✓ Render final React code"
491
- },
492
- "codegen": {
493
- "title": "2.3 Code Generation",
494
- "description": "Use various generation tools as needed:",
495
- "genapi": "Generate API documentation (OpenAPI/Swagger)",
496
- "gensql": "Natural language to SQL queries",
497
- "genmock": "Generate test data",
498
- "gentest": "Generate unit tests"
499
- }
500
- },
501
- "stage3": {
502
- "title": "Stage 3: Code Quality Assurance",
503
- "review": {
504
- "title": "3.1 Comprehensive Code Review (Recommended)",
505
- "description": "Use",
506
- "description2": "workflow to complete code review, security scan, and performance analysis at once.",
507
- "example1": "You: Review this code",
508
- "step1": "✓ Code Review (quality, style, best practices)",
509
- "step2": "✓ Security Scan (SQL injection, XSS, CSRF)",
510
- "step3": "✓ Performance Analysis (algorithms, memory, database)",
511
- "step4": "✓ Output comprehensive report"
512
- },
513
- "single": {
514
- "title": "3.2 Single Item Check",
515
- "description": "Use single tools for specific issues:",
516
- "codeReview": "Code review",
517
- "securityScan": "Security scan",
518
- "perf": "Performance analysis",
519
- "refactor": "Refactoring suggestions"
520
- }
521
- },
522
- "stage4": {
523
- "title": "Stage 4: Bug Fixing",
524
- "bugfix": {
525
- "title": "4.1 Systematic Bug Fix (Recommended)",
526
- "description": "Use",
527
- "description2": "workflow to run TBP 8-step root-cause analysis before repair and testing.",
528
- "example1": "You: Login function is throwing an error",
529
- "step1": "✓ Check project context, backfill missing graph docs, and refresh the GitNexus index",
530
- "step2": "✓ Use TBP-1~TBP-4 to define the symptom, timeline, and common pattern",
531
- "step3": "✓ Use TBP-5/6 to lock the failure boundary and causal root cause",
532
- "step4": "✓ Produce repair options and risks from the evidence chain",
533
- "step5": "✓ Generate validation steps and regression tests"
534
- },
535
- "quick": {
536
- "title": "4.2 Quick Bug Analysis",
537
- "description": "Use",
538
- "description2": "tool for fast TBP 8-step RCA with repair and validation guidance."
539
- }
540
- },
541
- "stage5": {
542
- "title": "Stage 5: Release Management",
543
- "release": {
544
- "title": "5.1 Automated Release Process (Recommended)",
545
- "description": "Use",
546
- "description2": "workflow to automatically generate Changelog and PR descriptions.",
547
- "example1": "You: Prepare to release v2.0.0",
548
- "step1": "✓ Generate CHANGELOG (categorized by feat/fix/breaking)",
549
- "step2": "✓ Generate PR description (change summary, impact scope)",
550
- "step3": "✓ Output release checklist"
551
- },
552
- "git": {
553
- "title": "5.2 Git Workflow",
554
- "description": "Use Git tools to improve collaboration efficiency:",
555
- "gencommit": "Generate standard commit messages",
556
- "genchangelog": "Generate CHANGELOG",
557
- "genpr": "Generate PR descriptions",
558
- "resolveConflict": "Resolve merge conflicts"
559
- }
560
- },
561
- "stage6": {
562
- "title": "Stage 6: Project Maintenance",
563
- "onboard": {
564
- "title": "6.1 New Member Onboarding",
565
- "description": "Use",
566
- "description2": "workflow to quickly understand the project.",
567
- "example1": "New member: I just joined the project, need to understand the project structure",
568
- "step1": "✓ Generate context documentation",
569
- "step2": "✓ Output development guidelines"
570
- },
571
- "doc": {
572
- "title": "6.2 Documentation Maintenance",
573
- "description": "Use",
574
- "description2": "workflow to complete project documentation with one click.",
575
- "step1": "✓ Generate code comments (JSDoc/TSDoc)",
576
- "step2": "✓ Generate README documentation",
577
- "step3": "✓ Generate API documentation",
578
- "step4": "✓ Output complete documentation set"
579
- }
580
- },
581
- "ralph": {
582
- "title": "Advanced Practice: Ralph Wiggum Loop",
583
- "advancedPractice": "Advanced Practice",
584
- "loop": {
585
- "title": "Automated Loop Development",
586
- "description": "Use",
587
- "description2": "to start automated development loop, AI continuously iterates until goal is achieved.",
588
- "example1": "You: Implement user authentication feature",
589
- "round1": "Round 1: Analyze requirements → Generate code",
590
- "round2": "Round 2: Run tests → Fix errors",
591
- "round3": "Round 3: Code review → Optimize code",
592
- "until": "Until: Tests pass + Requirements met"
593
- },
594
- "warning": {
595
- "title": "⚠️ Safety Notice:",
596
- "text": "Ralph Loop enables multiple safety protections by default (max iterations, runtime, code change limits) to prevent runaway."
597
- }
598
- },
599
- "summary": {
600
- "title": "Best Practices Summary",
601
- "coreTitle": "Core Principles:",
602
- "principle1": "Prioritize workflow orchestration tools (start_*) - automate complete processes",
603
- "principle2": "Use interview during requirements phase - avoid misunderstandings",
604
- "principle3": "Use estimate before development - plan time reasonably",
605
- "principle4": "Use start_review before commit - ensure code quality",
606
- "principle5": "Use start_release before release - standardize release process"
607
- },
608
- "resources": {
609
- "title": "More Resources",
610
- "allTools": "Complete Tools Reference",
611
- "allToolsDesc": "View detailed descriptions of all 27 tools",
612
- "gettingStarted": "Installation & Configuration",
613
- "gettingStartedDesc": "Quick start guide",
614
- "migration": "Migration Guide",
615
- "migrationDesc": "Migrate from v2.x to v3.0",
616
- "github": "GitHub Repository",
617
- "githubDesc": "Source code and issue feedback"
618
- },
619
- "practice": {
620
- "title": "🚀 Start Practicing",
621
- "description": "Apply these best practices to your project",
622
- "install": "📖 Installation & Configuration",
623
- "allTools": "🛠️ View All Tools"
624
- }
625
- }
626
- }