@programinglive/dev-workflow-mcp-server 1.3.7 โ†’ 1.3.9

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.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,25 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ### [1.3.9](https://github.com/programinglive/dev-workflow-mcp-server/compare/v1.3.8...v1.3.9) (2025-11-22)
6
+
7
+
8
+ ### โœจ Features
9
+
10
+ * **web:** improve documentation modal layout and readability ([ca033bd](https://github.com/programinglive/dev-workflow-mcp-server/commit/ca033bd1208283c46a6262b6f447f57246c19dc7))
11
+
12
+
13
+ ### ๐Ÿงน Chores
14
+
15
+ * rebuild Tailwind CSS ([b8a552e](https://github.com/programinglive/dev-workflow-mcp-server/commit/b8a552ebec854b4a50265fc9979c350a46a594ca))
16
+
17
+ ### [1.3.8](https://github.com/programinglive/dev-workflow-mcp-server/compare/v1.3.7...v1.3.8) (2025-11-22)
18
+
19
+
20
+ ### ๐Ÿ› Bug Fixes
21
+
22
+ * **web:** track dist/docs in git for production deployment ([95a9e87](https://github.com/programinglive/dev-workflow-mcp-server/commit/95a9e8792e7045a86435b6df0d44f31d6b9952f1))
23
+
5
24
  ### [1.3.7](https://github.com/programinglive/dev-workflow-mcp-server/compare/v1.3.6...v1.3.7) (2025-11-22)
6
25
 
7
26
 
@@ -0,0 +1,411 @@
1
+ <h1>Practical Examples for Dev-Workflow MCP Server</h1>
2
+ <p>This document provides real-world examples of using the dev-workflow MCP server in Antigravity.</p>
3
+ <h2>Table of Contents</h2>
4
+ <ul>
5
+ <li><a href="#simple-feature-development">Simple Feature Development</a></li>
6
+ <li><a href="#bug-fix-with-test-discovery">Bug Fix with Test Discovery</a></li>
7
+ <li><a href="#refactoring-workflow">Refactoring Workflow</a></li>
8
+ <li><a href="#using-run_full_workflow">Using run_full_workflow</a></li>
9
+ <li><a href="#multi-project-workflow">Multi-Project Workflow</a></li>
10
+ <li><a href="#per-user-workflow-isolation">Per-User Workflow Isolation</a></li>
11
+ <li><a href="#handling-test-failures">Handling Test Failures</a></li>
12
+ </ul>
13
+ <hr>
14
+ <h2>Simple Feature Development</h2>
15
+ <p><strong>Scenario:</strong> Adding a user profile avatar feature</p>
16
+ <h3>Step-by-Step</h3>
17
+ <p><strong>1. Start the task:</strong></p>
18
+ <pre><code>start_task:
19
+ description: &quot;Add user avatar upload and display&quot;
20
+ type: &quot;feature&quot;
21
+ </code></pre>
22
+ <p><strong>Response:</strong></p>
23
+ <pre><code>โœ… Task started: Add user avatar upload and display
24
+ ๐Ÿ“ Task ID: task-20231122-001
25
+ ๐Ÿ”„ Phase: implementation
26
+ Next: Implement the feature, then mark as fixed
27
+ </code></pre>
28
+ <p><strong>2. Implement the feature:</strong></p>
29
+ <ul>
30
+ <li>Create <code>components/Avatar.jsx</code></li>
31
+ <li>Add upload functionality</li>
32
+ <li>Integrate with user profile page</li>
33
+ </ul>
34
+ <p><strong>3. Mark as fixed:</strong></p>
35
+ <pre><code>mark_bug_fixed:
36
+ summary: &quot;Avatar component with upload, preview, and persistence&quot;
37
+ </code></pre>
38
+ <p><strong>4. Create tests:</strong></p>
39
+ <ul>
40
+ <li>Write <code>Avatar.test.jsx</code> with upload tests</li>
41
+ <li>Add integration tests for profile page</li>
42
+ </ul>
43
+ <pre><code>create_tests
44
+ </code></pre>
45
+ <p><strong>5. Run tests:</strong></p>
46
+ <pre><code class="language-bash">npm test
47
+ </code></pre>
48
+ <pre><code>run_tests:
49
+ passed: true
50
+ testCommand: &quot;npm test&quot;
51
+ details: &quot;31 tests passed (27 existing + 4 new avatar tests)&quot;
52
+ </code></pre>
53
+ <p><strong>6. Document:</strong>
54
+ Update <code>README.md</code> with avatar component usage:</p>
55
+ <pre><code>create_documentation:
56
+ documentationType: &quot;README&quot;
57
+ summary: &quot;Added Avatar component documentation with API reference and examples&quot;
58
+ </code></pre>
59
+ <p><strong>7. Commit and push:</strong></p>
60
+ <pre><code>commit_and_push:
61
+ commitMessage: &quot;feat(profile): add user avatar upload and display&quot;
62
+ </code></pre>
63
+ <p><strong>8. Release:</strong></p>
64
+ <pre><code>perform_release:
65
+ command: &quot;npm run release:minor&quot;
66
+ notes: &quot;v1.3.0 - User avatar feature&quot;
67
+ </code></pre>
68
+ <p><strong>9. Complete:</strong></p>
69
+ <pre><code>complete_task:
70
+ commitMessage: &quot;feat(profile): add user avatar upload and display&quot;
71
+ </code></pre>
72
+ <hr>
73
+ <h2>Bug Fix with Test Discovery</h2>
74
+ <p><strong>Scenario:</strong> Fixing a date formatting bug discovered in production</p>
75
+ <h3>Workflow</h3>
76
+ <p><strong>1. Start:</strong></p>
77
+ <pre><code>start_task:
78
+ description: &quot;Fix incorrect date format in transaction history&quot;
79
+ type: &quot;bugfix&quot;
80
+ </code></pre>
81
+ <p><strong>2. Reproduce and fix:</strong></p>
82
+ <ul>
83
+ <li>Find the bug in <code>utils/formatDate.js</code></li>
84
+ <li>Fix the formatting logic</li>
85
+ <li>Verify the fix</li>
86
+ </ul>
87
+ <p><strong>3. Mark as fixed:</strong></p>
88
+ <pre><code>mark_bug_fixed:
89
+ summary: &quot;Corrected date formatting to use ISO 8601 format&quot;
90
+ </code></pre>
91
+ <p><strong>4. Create regression test:</strong>
92
+ Create <code>utils/formatDate.test.js</code>:</p>
93
+ <pre><code class="language-javascript">describe(&#39;formatDate&#39;, () =&gt; {
94
+ it(&#39;formats dates in ISO 8601 format&#39;, () =&gt; {
95
+ const date = new Date(&#39;2023-11-22T10:30:00Z&#39;);
96
+ expect(formatDate(date)).toBe(&#39;2023-11-22&#39;);
97
+ });
98
+
99
+ it(&#39;handles timezone correctly&#39;, () =&gt; {
100
+ // Regression test for the bug
101
+ const date = new Date(&#39;2023-11-22T23:00:00-05:00&#39;);
102
+ expect(formatDate(date)).toBe(&#39;2023-11-22&#39;);
103
+ });
104
+ });
105
+ </code></pre>
106
+ <pre><code>create_tests
107
+ </code></pre>
108
+ <p><strong>5. Run tests:</strong></p>
109
+ <pre><code>run_tests:
110
+ passed: true
111
+ testCommand: &quot;npm test -- utils/formatDate.test.js&quot;
112
+ details: &quot;2 new tests pass, including regression test&quot;
113
+ </code></pre>
114
+ <p><strong>6. Document:</strong>
115
+ Update <code>CHANGELOG.md</code>:</p>
116
+ <pre><code>create_documentation:
117
+ documentationType: &quot;changelog&quot;
118
+ summary: &quot;Added bug fix entry for date formatting issue&quot;
119
+ </code></pre>
120
+ <p><strong>7. Commit:</strong></p>
121
+ <pre><code>commit_and_push:
122
+ commitMessage: &quot;fix(utils): correct date formatting to use ISO 8601&quot;
123
+ </code></pre>
124
+ <p><strong>8. Release:</strong></p>
125
+ <pre><code>perform_release:
126
+ command: &quot;npm run release:patch&quot;
127
+ notes: &quot;v1.2.1 - Hotfix for date formatting&quot;
128
+ </code></pre>
129
+ <p><strong>9. Complete:</strong></p>
130
+ <pre><code>complete_task:
131
+ commitMessage: &quot;fix(utils): correct date formatting to use ISO 8601&quot;
132
+ </code></pre>
133
+ <hr>
134
+ <h2>Refactoring Workflow</h2>
135
+ <p><strong>Scenario:</strong> Refactoring API service layer for better maintainability</p>
136
+ <h3>Workflow</h3>
137
+ <p><strong>1. Start:</strong></p>
138
+ <pre><code>start_task:
139
+ description: &quot;Refactor API service layer to use interceptors pattern&quot;
140
+ type: &quot;refactor&quot;
141
+ </code></pre>
142
+ <p><strong>2. Refactor code:</strong></p>
143
+ <ul>
144
+ <li>Extract common logic to interceptors</li>
145
+ <li>Update all API calls to use new pattern</li>
146
+ <li>Ensure backward compatibility</li>
147
+ </ul>
148
+ <p><strong>3. Mark as fixed:</strong></p>
149
+ <pre><code>mark_bug_fixed:
150
+ summary: &quot;Refactored API service to use axios interceptors for auth and error handling&quot;
151
+ </code></pre>
152
+ <p><strong>4. Update existing tests:</strong>
153
+ Since this is a refactor, update existing tests to work with new structure:</p>
154
+ <pre><code>create_tests
155
+ </code></pre>
156
+ <p><strong>5. Run comprehensive test suite:</strong></p>
157
+ <pre><code>run_tests:
158
+ passed: true
159
+ testCommand: &quot;npm test -- --coverage&quot;
160
+ details: &quot;All 127 tests pass. Coverage: 94% โ†’ 96%&quot;
161
+ </code></pre>
162
+ <p><strong>6. Document changes:</strong>
163
+ Update inline comments and architecture docs:</p>
164
+ <pre><code>create_documentation:
165
+ documentationType: &quot;inline-comments&quot;
166
+ summary: &quot;Added JSDoc comments for interceptors and updated architecture diagram&quot;
167
+ </code></pre>
168
+ <p><strong>7. Commit:</strong></p>
169
+ <pre><code>commit_and_push:
170
+ commitMessage: &quot;refactor(api): use interceptors pattern for auth and error handling&quot;
171
+ </code></pre>
172
+ <p><strong>8. Release:</strong></p>
173
+ <pre><code>perform_release:
174
+ command: &quot;npm run release:minor&quot;
175
+ notes: &quot;v1.4.0 - API service refactoring (internal improvement)&quot;
176
+ </code></pre>
177
+ <p><strong>9. Complete:</strong></p>
178
+ <pre><code>complete_task:
179
+ commitMessage: &quot;refactor(api): use interceptors pattern for auth and error handling&quot;
180
+ </code></pre>
181
+ <hr>
182
+ <h2>Using run_full_workflow</h2>
183
+ <p><strong>Scenario:</strong> Quick feature when you know all the details upfront</p>
184
+ <p>The <code>run_full_workflow</code> tool executes all workflow steps in one call:</p>
185
+ <pre><code>run_full_workflow:
186
+ summary: &quot;Add dark mode toggle to settings&quot;
187
+ testCommand: &quot;npm test&quot;
188
+ testsPassed: true
189
+ testDetails: &quot;3 new tests for dark mode: all pass&quot;
190
+ documentationType: &quot;README&quot;
191
+ documentationSummary: &quot;Added dark mode section to README with usage&quot;
192
+ commitMessage: &quot;feat(ui): add dark mode toggle to settings&quot;
193
+ releaseCommand: &quot;npm run release:minor&quot;
194
+ releaseNotes: &quot;v1.5.0 - Dark mode support&quot;
195
+ </code></pre>
196
+ <p>This single call:</p>
197
+ <ol>
198
+ <li>โœ… Marks the feature as fixed</li>
199
+ <li>โœ… Records test creation</li>
200
+ <li>โœ… Records test execution</li>
201
+ <li>โœ… Records documentation</li>
202
+ <li>โœ… Checks ready to commit</li>
203
+ <li>โœ… Commits and pushes</li>
204
+ <li>โœ… Performs release</li>
205
+ <li>โœ… Completes the task</li>
206
+ </ol>
207
+ <p><strong>When to use:</strong></p>
208
+ <ul>
209
+ <li>Simple, well-defined features</li>
210
+ <li>You&#39;ve already done the work and just need to record it</li>
211
+ <li>Batch processing multiple small changes</li>
212
+ </ul>
213
+ <p><strong>When not to use:</strong></p>
214
+ <ul>
215
+ <li>Complex features requiring step-by-step verification</li>
216
+ <li>When tests might fail (you need to fix them first)</li>
217
+ <li>Learning the workflow for the first time</li>
218
+ </ul>
219
+ <hr>
220
+ <h2>Multi-Project Workflow</h2>
221
+ <p><strong>Scenario:</strong> Working on multiple projects with separate workflow histories</p>
222
+ <h3>Setup</h3>
223
+ <p>Each project gets its own <code>.state/workflow-state.json</code>:</p>
224
+ <pre><code class="language-bash"># Project A
225
+ cd ~/projects/frontend-app
226
+ npm install @programinglive/dev-workflow-mcp-server
227
+
228
+ # Project B
229
+ cd ~/projects/backend-api
230
+ npm install @programinglive/dev-workflow-mcp-server
231
+ </code></pre>
232
+ <h3>Usage</h3>
233
+ <p>Workflows are automatically isolated by project:</p>
234
+ <p><strong>In frontend-app:</strong></p>
235
+ <pre><code>start_task:
236
+ description: &quot;Add checkout flow&quot;
237
+ type: &quot;feature&quot;
238
+
239
+ # Work on frontend...
240
+ # Complete workflow...
241
+ </code></pre>
242
+ <p><strong>In backend-api:</strong></p>
243
+ <pre><code>start_task:
244
+ description: &quot;Add payment webhook endpoint&quot;
245
+ type: &quot;feature&quot;
246
+
247
+ # Work on backend...
248
+ # Complete workflow...
249
+ </code></pre>
250
+ <p>Each project tracks its own:</p>
251
+ <ul>
252
+ <li>Current task</li>
253
+ <li>Workflow phase</li>
254
+ <li>History</li>
255
+ </ul>
256
+ <p>View history for current project:</p>
257
+ <pre><code>view_history:
258
+ limit: 5
259
+ </code></pre>
260
+ <p>This shows only the history for the current project!</p>
261
+ <hr>
262
+ <h2>Per-User Workflow Isolation</h2>
263
+ <p><strong>Scenario:</strong> Multiple developers on the same machine or shared repository</p>
264
+ <h3>Configuration</h3>
265
+ <p>Set unique user IDs for each developer:</p>
266
+ <p><strong>Developer 1 (Alice):</strong></p>
267
+ <pre><code class="language-json">{
268
+ &quot;mcpServers&quot;: {
269
+ &quot;dev-workflow&quot;: {
270
+ &quot;command&quot;: &quot;node&quot;,
271
+ &quot;args&quot;: [&quot;d:\\code\\dev-workflow-mcp-server\\index.js&quot;],
272
+ &quot;env&quot;: {
273
+ &quot;DEV_WORKFLOW_USER_ID&quot;: &quot;alice&quot;
274
+ }
275
+ }
276
+ }
277
+ }
278
+ </code></pre>
279
+ <p><strong>Developer 2 (Bob):</strong></p>
280
+ <pre><code class="language-json">{
281
+ &quot;mcpServers&quot;: {
282
+ &quot;dev-workflow&quot;: {
283
+ &quot;command&quot;: &quot;node&quot;,
284
+ &quot;args&quot;: [&quot;d:\\code\\dev-workflow-mcp-server\\index.js&quot;],
285
+ &quot;env&quot;: {
286
+ &quot;DEV_WORKFLOW_USER_ID&quot;: &quot;bob&quot;
287
+ }
288
+ }
289
+ }
290
+ }
291
+ </code></pre>
292
+ <h3>Result</h3>
293
+ <p>Workflow states are isolated:</p>
294
+ <ul>
295
+ <li><code>.state/users/alice/workflow-state.db</code> - Alice&#39;s history</li>
296
+ <li><code>.state/users/bob/workflow-state.db</code> - Bob&#39;s history</li>
297
+ </ul>
298
+ <p>Each developer can:</p>
299
+ <ul>
300
+ <li>Work on different tasks simultaneously</li>
301
+ <li>Have independent workflow phases</li>
302
+ <li>View their own history without seeing others</li>
303
+ </ul>
304
+ <h3>Web Dashboard</h3>
305
+ <p>View specific user&#39;s history:</p>
306
+ <pre><code class="language-bash">npm run web
307
+ # Opens http://localhost:3111
308
+
309
+ # Filter by user:
310
+ # http://localhost:3111?user=alice
311
+ # http://localhost:3111?user=bob
312
+ </code></pre>
313
+ <hr>
314
+ <h2>Handling Test Failures</h2>
315
+ <p><strong>Scenario:</strong> Tests fail during workflow</p>
316
+ <h3>Workflow with Failure</h3>
317
+ <p><strong>1. Start and implement:</strong></p>
318
+ <pre><code>start_task:
319
+ description: &quot;Add email validation to signup form&quot;
320
+ type: &quot;feature&quot;
321
+
322
+ mark_bug_fixed:
323
+ summary: &quot;Email validation with regex and domain verification&quot;
324
+
325
+ create_tests
326
+ </code></pre>
327
+ <p><strong>2. Run tests (they fail!):</strong></p>
328
+ <pre><code>run_tests:
329
+ passed: false
330
+ testCommand: &quot;npm test&quot;
331
+ details: &quot;2 of 4 tests failed: Invalid email format not caught&quot;
332
+ </code></pre>
333
+ <p><strong>Response:</strong></p>
334
+ <pre><code>โŒ Tests FAILED!
335
+ ๐Ÿšซ Cannot proceed to commit with failing tests
336
+ ๐Ÿ“ Current phase: testing (blocked)
337
+
338
+ You must:
339
+ 1. Fix the failing tests
340
+ 2. Re-run tests with passed: true
341
+ </code></pre>
342
+ <p><strong>3. Fix the bugs:</strong></p>
343
+ <ul>
344
+ <li>Update validation regex</li>
345
+ <li>Fix edge case handling</li>
346
+ </ul>
347
+ <p><strong>4. Run tests again:</strong></p>
348
+ <pre><code>run_tests:
349
+ passed: true
350
+ testCommand: &quot;npm test&quot;
351
+ details: &quot;All 4 tests now pass&quot;
352
+ </code></pre>
353
+ <p><strong>Response:</strong></p>
354
+ <pre><code>โœ… Tests passed!
355
+ โœ… Testing phase complete
356
+ Next: Create documentation
357
+ </code></pre>
358
+ <p><strong>5. Continue workflow:</strong></p>
359
+ <pre><code>create_documentation:
360
+ documentationType: &quot;inline-comments&quot;
361
+ summary: &quot;Added validation rules documentation&quot;
362
+
363
+ commit_and_push:
364
+ commitMessage: &quot;feat(auth): add email validation to signup&quot;
365
+
366
+ perform_release:
367
+ command: &quot;npm run release:minor&quot;
368
+
369
+ complete_task:
370
+ commitMessage: &quot;feat(auth): add email validation to signup&quot;
371
+ </code></pre>
372
+ <h3>Key Takeaway</h3>
373
+ <p><strong>The workflow blocks commits when tests fail!</strong> This enforces quality and prevents broken code from reaching your repository.</p>
374
+ <hr>
375
+ <h2>Advanced: Skipping Tests</h2>
376
+ <p><strong>Scenario:</strong> Manual testing required (mobile app, hardware integration, etc.)</p>
377
+ <pre><code>start_task:
378
+ description: &quot;Add iOS biometric authentication&quot;
379
+ type: &quot;feature&quot;
380
+
381
+ mark_bug_fixed:
382
+ summary: &quot;Face ID and Touch ID integration complete&quot;
383
+
384
+ skip_tests:
385
+ reason: &quot;Biometric auth requires physical iOS device testing; automated tests not feasible. Manual QA completed on iPhone 14 Pro and iPhone 12.&quot;
386
+ </code></pre>
387
+ <p><strong>Response:</strong></p>
388
+ <pre><code>โš ๏ธ Tests skipped with justification
389
+ โœ… Testing phase marked as satisfied
390
+ ๐Ÿ“ Task flagged for manual verification
391
+
392
+ Reason: Biometric auth requires physical iOS device testing; automated tests not feasible. Manual QA completed on iPhone 14 Pro and iPhone 12.
393
+
394
+ Next: Create documentation
395
+ </code></pre>
396
+ <p><strong>When to skip tests:</strong></p>
397
+ <ul>
398
+ <li>Hardware-dependent features</li>
399
+ <li>Manual UI testing on specific devices</li>
400
+ <li>Third-party service integration (with mocking limitations)</li>
401
+ </ul>
402
+ <p><strong>Best practice:</strong> Always provide detailed justification for audit trail.</p>
403
+ <hr>
404
+ <h2>Next Steps</h2>
405
+ <ul>
406
+ <li>Check <a href="./WORKFLOW-TEMPLATES.md">WORKFLOW-TEMPLATES.md</a> for ready-to-use templates</li>
407
+ <li>See <a href="./TROUBLESHOOTING.md">TROUBLESHOOTING.md</a> for common issues</li>
408
+ <li>Return to <a href="./GETTING-STARTED.md">GETTING-STARTED.md</a> for setup instructions</li>
409
+ </ul>
410
+ <hr>
411
+ <p><strong>Happy coding with disciplined workflows!</strong> ๐ŸŽฏ</p>
@@ -0,0 +1,233 @@
1
+ <h1>Getting Started with Dev-Workflow MCP Server in Antigravity</h1>
2
+ <p>This guide will help you set up and use the dev-workflow MCP server in the Antigravity text editor.</p>
3
+ <h2>What is Dev-Workflow MCP Server?</h2>
4
+ <p>The dev-workflow MCP server is a development discipline enforcer that guides you through proper software development workflows. It ensures you:</p>
5
+ <ul>
6
+ <li>โœ… Start with a clear task description</li>
7
+ <li>โœ… Write tests for your changes</li>
8
+ <li>โœ… Run tests (and block commits if they fail)</li>
9
+ <li>โœ… Document your work</li>
10
+ <li>โœ… Follow a structured commit and release process</li>
11
+ <li>โœ… Track your development history</li>
12
+ </ul>
13
+ <h2>Prerequisites</h2>
14
+ <ul>
15
+ <li><strong>Node.js</strong> (v18 or later)</li>
16
+ <li><strong>Antigravity</strong> text editor</li>
17
+ <li><strong>Git</strong> installed and configured</li>
18
+ <li>Basic understanding of terminal commands</li>
19
+ </ul>
20
+ <h2>Installation</h2>
21
+ <h3>Option 1: Install in Your Project (Recommended)</h3>
22
+ <p>This creates a project-specific workflow state:</p>
23
+ <pre><code class="language-bash">cd your-project
24
+ npm install @programinglive/dev-workflow-mcp-server
25
+ </code></pre>
26
+ <p>This automatically creates <code>.state/workflow-state.json</code> in your project root.</p>
27
+ <h3>Option 2: Install from Source</h3>
28
+ <pre><code class="language-bash">git clone https://github.com/programinglive/dev-workflow-mcp-server.git
29
+ cd dev-workflow-mcp-server
30
+ npm install
31
+ </code></pre>
32
+ <h2>Configuration in Antigravity</h2>
33
+ <p>Antigravity uses an MCP configuration file located at:</p>
34
+ <p><strong>Windows:</strong> <code>%APPDATA%\Antigravity\mcp_config.json</code> or <code>C:\Users\&lt;USERNAME&gt;\.gemini\antigravity\mcp_config.json</code></p>
35
+ <p><strong>macOS:</strong> <code>~/Library/Application Support/Antigravity/mcp_config.json</code></p>
36
+ <p><strong>Linux:</strong> <code>~/.config/antigravity/mcp_config.json</code></p>
37
+ <h3>Configuration File</h3>
38
+ <p>Create or edit the <code>mcp_config.json</code> file:</p>
39
+ <pre><code class="language-json">{
40
+ &quot;mcpServers&quot;: {
41
+ &quot;dev-workflow&quot;: {
42
+ &quot;command&quot;: &quot;node&quot;,
43
+ &quot;args&quot;: [
44
+ &quot;d:\\code\\dev-workflow-mcp-server\\index.js&quot;
45
+ ]
46
+ }
47
+ }
48
+ }
49
+ </code></pre>
50
+ <p><strong>Important Notes:</strong></p>
51
+ <ul>
52
+ <li>Use <strong>absolute paths</strong> to <code>index.js</code></li>
53
+ <li>On Windows, use <strong>escaped backslashes</strong> (<code>\\</code>) in JSON</li>
54
+ <li>Restart Antigravity after editing the configuration</li>
55
+ </ul>
56
+ <h3>Verify Installation</h3>
57
+ <p>After restarting Antigravity, you should see dev-workflow tools available. You can verify by:</p>
58
+ <ol>
59
+ <li>Opening Antigravity</li>
60
+ <li>Checking if MCP tools like <code>start_task</code>, <code>get_workflow_status</code> are available</li>
61
+ <li>Running <code>get_workflow_status</code> to see the initial state</li>
62
+ </ol>
63
+ <h2>Your First Workflow</h2>
64
+ <p>Let&#39;s walk through a complete development workflow:</p>
65
+ <h3>1. Start a New Task</h3>
66
+ <pre><code>Use start_task to begin:
67
+ - description: &quot;Add header component to landing page&quot;
68
+ - type: &quot;feature&quot;
69
+ </code></pre>
70
+ <p>The MCP server responds with your task ID and current phase.</p>
71
+ <h3>2. Write Your Code</h3>
72
+ <p>Implement your feature as you normally would. The workflow doesn&#39;t interfere with your coding.</p>
73
+ <h3>3. Mark as Fixed</h3>
74
+ <p>Once you&#39;ve completed the implementation:</p>
75
+ <pre><code>Use mark_bug_fixed:
76
+ - summary: &quot;Header component with logo and navigation menu&quot;
77
+ </code></pre>
78
+ <h3>4. Create Tests</h3>
79
+ <p>The server will remind you to create tests. Write your tests, then:</p>
80
+ <pre><code>Use create_tests (no parameters needed)
81
+ </code></pre>
82
+ <h3>5. Run Tests</h3>
83
+ <p>Execute your test suite and record the results:</p>
84
+ <pre><code>Use run_tests:
85
+ - passed: true
86
+ - testCommand: &quot;npm test&quot;
87
+ - details: &quot;All 25 tests passed&quot;
88
+ </code></pre>
89
+ <blockquote>
90
+ <p><strong>Important:</strong> If tests fail, the workflow will block you from proceeding!</p>
91
+ </blockquote>
92
+ <h3>6. Create Documentation</h3>
93
+ <p>Update your documentation (README, inline comments, etc.):</p>
94
+ <pre><code>Use create_documentation:
95
+ - documentationType: &quot;README&quot;
96
+ - summary: &quot;Added header component documentation and usage examples&quot;
97
+ </code></pre>
98
+ <h3>7. Commit and Push</h3>
99
+ <p>The server will automatically stage, commit, and push your changes:</p>
100
+ <pre><code>Use commit_and_push:
101
+ - commitMessage: &quot;feat: add header component with navigation&quot;
102
+ </code></pre>
103
+ <p>The branch is auto-detected (main or master).</p>
104
+ <h3>8. Perform Release</h3>
105
+ <p>Record your release:</p>
106
+ <pre><code>Use perform_release:
107
+ - command: &quot;npm run release:patch&quot;
108
+ - notes: &quot;Released header component&quot;
109
+ </code></pre>
110
+ <h3>9. Complete Task</h3>
111
+ <p>Finally, mark the task as complete:</p>
112
+ <pre><code>Use complete_task:
113
+ - commitMessage: &quot;feat: add header component with navigation&quot;
114
+ </code></pre>
115
+ <h2>Antigravity vs. Windsurf</h2>
116
+ <h3>Key Differences</h3>
117
+ <table>
118
+ <thead>
119
+ <tr>
120
+ <th>Feature</th>
121
+ <th>Antigravity</th>
122
+ <th>Windsurf</th>
123
+ </tr>
124
+ </thead>
125
+ <tbody><tr>
126
+ <td><strong>Configuration</strong></td>
127
+ <td><code>mcp_config.json</code> in <code>.gemini</code></td>
128
+ <td><code>config.json</code> in app data</td>
129
+ </tr>
130
+ <tr>
131
+ <td><strong>Tool Invocation</strong></td>
132
+ <td>Direct MCP tool calls</td>
133
+ <td>May use different interfaces</td>
134
+ </tr>
135
+ <tr>
136
+ <td><strong>Workflow State</strong></td>
137
+ <td>Per-user isolation with <code>DEV_WORKFLOW_USER_ID</code></td>
138
+ <td>Shared state</td>
139
+ </tr>
140
+ <tr>
141
+ <td><strong>Path Format</strong></td>
142
+ <td>Windows requires <code>\\</code> escaping</td>
143
+ <td>Same</td>
144
+ </tr>
145
+ </tbody></table>
146
+ <h3>Avoiding Conflicts</h3>
147
+ <p>If you use both Antigravity and Windsurf:</p>
148
+ <ol>
149
+ <li><p><strong>Use separate user IDs</strong> to isolate workflow states:</p>
150
+ <pre><code class="language-bash"># In Antigravity MCP config, add environment variable
151
+ export DEV_WORKFLOW_USER_ID=antigravity-user
152
+
153
+ # In Windsurf, use different ID
154
+ export DEV_WORKFLOW_USER_ID=windsurf-user
155
+ </code></pre>
156
+ </li>
157
+ <li><p><strong>Don&#39;t run both simultaneously</strong> on the same project to avoid state conflicts</p>
158
+ </li>
159
+ <li><p><strong>Use project-specific installations</strong> to keep states isolated per project</p>
160
+ </li>
161
+ </ol>
162
+ <h2>Common Workflows</h2>
163
+ <h3>Quick Feature Development</h3>
164
+ <p>For simple features, use <code>run_full_workflow</code>:</p>
165
+ <pre><code>Use run_full_workflow with:
166
+ - summary: &quot;Add contact form&quot;
167
+ - testCommand: &quot;npm test&quot;
168
+ - documentationType: &quot;README&quot;
169
+ - documentationSummary: &quot;Added contact form docs&quot;
170
+ - commitMessage: &quot;feat: add contact form&quot;
171
+ - releaseCommand: &quot;npm run release:minor&quot;
172
+ - testsPassed: true
173
+ </code></pre>
174
+ <p>This executes all workflow steps in one go!</p>
175
+ <h3>Bug Fix Workflow</h3>
176
+ <ol>
177
+ <li><code>start_task</code> with type &quot;bugfix&quot;</li>
178
+ <li>Fix the bug</li>
179
+ <li><code>mark_bug_fixed</code></li>
180
+ <li>Create regression tests</li>
181
+ <li><code>create_tests</code></li>
182
+ <li><code>run_tests</code></li>
183
+ <li><code>create_documentation</code> (changelog)</li>
184
+ <li><code>commit_and_push</code></li>
185
+ <li><code>perform_release</code></li>
186
+ <li><code>complete_task</code></li>
187
+ </ol>
188
+ <h3>When Tests Can&#39;t Be Automated</h3>
189
+ <p>Sometimes automated tests aren&#39;t feasible (e.g., manual UI testing):</p>
190
+ <pre><code>Use skip_tests:
191
+ - reason: &quot;Mobile device testing requires manual QA on physical devices&quot;
192
+ </code></pre>
193
+ <p>This flags the task for manual verification but allows the workflow to continue.</p>
194
+ <h2>Checking Your Status</h2>
195
+ <p>At any time, check where you are:</p>
196
+ <pre><code>Use get_workflow_status
197
+ </code></pre>
198
+ <p>This shows:</p>
199
+ <ul>
200
+ <li>Current task description</li>
201
+ <li>Active phase (implementation, testing, documentation, etc.)</li>
202
+ <li>Completed steps</li>
203
+ <li>Next required step</li>
204
+ </ul>
205
+ <h2>Viewing History</h2>
206
+ <p>See your completed tasks:</p>
207
+ <pre><code>Use view_history:
208
+ - limit: 10
209
+ </code></pre>
210
+ <p>This displays your recent workflow completions.</p>
211
+ <h2>Next Steps</h2>
212
+ <ul>
213
+ <li>Read <a href="./EXAMPLES.md">EXAMPLES.md</a> for detailed real-world examples</li>
214
+ <li>Check <a href="./WORKFLOW-TEMPLATES.md">WORKFLOW-TEMPLATES.md</a> for ready-to-use templates</li>
215
+ <li>See <a href="./TROUBLESHOOTING.md">TROUBLESHOOTING.md</a> if you encounter issues</li>
216
+ </ul>
217
+ <h2>Tips for Success</h2>
218
+ <ol>
219
+ <li><strong>Always start with <code>start_task</code></strong> - This clarifies your intention</li>
220
+ <li><strong>Never skip tests</strong> - They&#39;re mandatory for production code</li>
221
+ <li><strong>Use conventional commit messages</strong> - e.g., <code>feat:</code>, <code>fix:</code>, <code>docs:</code></li>
222
+ <li><strong>Keep tasks focused</strong> - One feature/bugfix per workflow</li>
223
+ <li><strong>Check status frequently</strong> - Use <code>get_workflow_status</code> to stay on track</li>
224
+ <li><strong>Review history</strong> - Learn from your past workflows</li>
225
+ </ol>
226
+ <h2>Getting Help</h2>
227
+ <ul>
228
+ <li><strong>Documentation:</strong> <a href="../../README.md">Main README</a></li>
229
+ <li><strong>GitHub Issues:</strong> <a href="https://github.com/programinglive/dev-workflow-mcp-server/issues">Report bugs or request features</a></li>
230
+ <li><strong>Troubleshooting:</strong> <a href="./TROUBLESHOOTING.md">Common issues and solutions</a></li>
231
+ </ul>
232
+ <hr>
233
+ <p><strong>Ready to enforce development discipline with Antigravity? Start your first workflow now!</strong> ๐Ÿš€</p>