|
| 1 | +# Development Plan: responsible-vibe (workflow-descriptions-in-start_development branch) |
| 2 | + |
| 3 | +*Generated on 2025-08-12 by Vibe Feature MCP* |
| 4 | +*Workflow: [minor](https://mrsimpson.github.io/responsible-vibe-mcp/workflows/minor)* |
| 5 | + |
| 6 | +## Goal |
| 7 | +Enhance the discoverability of available workflow templates to make it easier for the LLM to start development with the best workflow for the task at hand. |
| 8 | + |
| 9 | +## Explore |
| 10 | +### Tasks |
| 11 | +- [x] Analyze current workflow selection mechanism in start_development tool |
| 12 | +- [x] Examine workflow manager and how workflows are loaded and presented |
| 13 | +- [x] Review available workflow files and their structure |
| 14 | +- [x] Identify the current workflow description generation process |
| 15 | +- [x] Identify specific discoverability issues and improvement opportunities |
| 16 | +- [x] Design solution approach for enhanced workflow discoverability |
| 17 | +- [x] Document requirements in requirements.md |
| 18 | +- [x] Define scope and implementation approach |
| 19 | + |
| 20 | +### Completed |
| 21 | +- [x] Created development plan file |
| 22 | +- [x] Analyzed start_development handler implementation |
| 23 | +- [x] Examined workflow manager and workflow loading mechanism |
| 24 | +- [x] Reviewed workflow YAML files structure (waterfall, epcc, minor, etc.) |
| 25 | +- [x] Found current workflow description generation in server-helpers.ts |
| 26 | +- [x] Documented 4 requirements for enhanced workflow discoverability |
| 27 | +- [x] Designed solution approach focusing on generateWorkflowDescription enhancement |
| 28 | + |
| 29 | +## Implement |
| 30 | + |
| 31 | +### Phase Entrance Criteria: |
| 32 | +- [x] The current workflow selection mechanism has been analyzed |
| 33 | +- [x] The problem with workflow discoverability has been clearly identified |
| 34 | +- [x] A solution approach has been designed and documented |
| 35 | +- [x] The scope of changes has been defined (minor enhancement) |
| 36 | +- [x] Implementation approach is clear and feasible |
| 37 | + |
| 38 | +### Tasks |
| 39 | +- [x] Extend WorkflowInfo interface to include metadata fields (_Requirements: REQ-1, REQ-3_) |
| 40 | +- [x] Add optional metadata to workflow YAML files (_Requirements: REQ-1, REQ-2, REQ-3_) |
| 41 | +- [x] Enhance WorkflowManager to parse metadata from YAML files (_Requirements: REQ-3_) |
| 42 | +- [x] Improve generateWorkflowDescription() function with richer descriptions (_Requirements: REQ-1, REQ-2_) |
| 43 | +- [x] Test enhanced workflow descriptions (_Requirements: REQ-4_) |
| 44 | +- [x] Verify backward compatibility (_Requirements: REQ-4_) |
| 45 | +- [ ] Update any relevant documentation |
| 46 | + |
| 47 | +### Completed |
| 48 | +- [x] Extended WorkflowInfo interface with optional metadata fields |
| 49 | +- [x] Added metadata to YamlStateMachine interface for type safety |
| 50 | +- [x] Enhanced all 7 workflow YAML files with comprehensive metadata |
| 51 | +- [x] Updated WorkflowManager to include metadata in WorkflowInfo objects |
| 52 | +- [x] Completely rewrote generateWorkflowDescription() function with rich formatting |
| 53 | +- [x] Verified all tests pass (221/221 tests passing) |
| 54 | +- [x] Tested enhanced descriptions with manual verification script |
| 55 | +- [x] Confirmed backward compatibility maintained |
| 56 | + |
| 57 | +### Completed |
| 58 | +*None yet* |
| 59 | + |
| 60 | +## Key Decisions |
| 61 | + |
| 62 | +### Current Workflow Selection Analysis |
| 63 | +- **Current mechanism**: Workflows are presented as enum options in start_development tool with basic descriptions |
| 64 | +- **Description generation**: `generateWorkflowDescription()` in server-helpers.ts creates simple bullet-point list |
| 65 | +- **Available workflows**: 7 predefined workflows (waterfall, epcc, minor, bugfix, greenfield, slides, posts) + custom |
| 66 | +- **Information provided**: Only name and brief description (e.g., "waterfall - From Specification down to test – the historical way") |
| 67 | +- **Discoverability issues identified**: |
| 68 | + 1. Limited context about when to use each workflow |
| 69 | + 2. No guidance on workflow suitability for different task types |
| 70 | + 3. No examples or use cases provided |
| 71 | + 4. No information about workflow phases or complexity |
| 72 | + 5. LLM has to guess which workflow fits the user's needs best |
| 73 | + |
| 74 | +### Enhancement Opportunities |
| 75 | +- Add more detailed workflow descriptions with use cases |
| 76 | +- Include workflow complexity indicators (phases, duration estimates) |
| 77 | +- Provide task-type recommendations (e.g., "best for bug fixes", "ideal for new features") |
| 78 | +- Add examples of when to use each workflow |
| 79 | + |
| 80 | +### Solution Approach (Minor Enhancement) |
| 81 | +**Target**: Enhance `generateWorkflowDescription()` function in `server-helpers.ts` |
| 82 | +**Scope**: |
| 83 | +1. **Extend WorkflowInfo interface** to include metadata (use cases, complexity, task types) |
| 84 | +2. **Enhance workflow YAML files** with additional metadata fields (optional, backward compatible) |
| 85 | +3. **Improve generateWorkflowDescription()** to create richer, more informative descriptions |
| 86 | +4. **Maintain backward compatibility** - no breaking changes to existing tool schema |
| 87 | + |
| 88 | +**Implementation Strategy**: |
| 89 | +- Add optional metadata fields to workflow YAML files |
| 90 | +- Extend WorkflowManager to parse and provide metadata |
| 91 | +- Enhance description generation with use cases, complexity indicators, and task-type guidance |
| 92 | +- Keep changes minimal and focused (minor enhancement scope) |
| 93 | + |
| 94 | +### Implementation Results |
| 95 | +**Successfully Enhanced**: |
| 96 | +- **WorkflowInfo interface**: Added optional metadata with complexity, duration, bestFor, useCases, examples |
| 97 | +- **YamlStateMachine interface**: Added metadata field for type safety |
| 98 | +- **All 7 workflow YAML files**: Enhanced with comprehensive metadata including: |
| 99 | + - Complexity levels (low/medium/high) |
| 100 | + - Estimated durations (1-2 hours to 2-5 days) |
| 101 | + - Task type recommendations (bug fixes, new features, etc.) |
| 102 | + - Specific use cases and examples |
| 103 | +- **generateWorkflowDescription() function**: Completely rewritten to provide rich, formatted descriptions |
| 104 | +- **Backward compatibility**: Maintained - all existing functionality preserved |
| 105 | +- **Testing**: All 221 tests pass, manual verification confirms enhanced descriptions work correctly |
| 106 | + |
| 107 | +**Impact**: LLMs now receive detailed workflow information including complexity, duration, use cases, and examples, enabling much better workflow selection recommendations. |
| 108 | + |
| 109 | +## Notes |
| 110 | +*Additional context and observations* |
| 111 | + |
| 112 | +--- |
| 113 | +*This plan is maintained by the LLM. Tool responses provide guidance on which section to focus on and what tasks to work on.* |
0 commit comments