@jmkim85/dev-flow-mcp
Version:
MCP-based Dev Flow - AI-powered development workflow management with 13 essential tools for TDD and context management
83 lines (65 loc) • 2.21 kB
Markdown
# Project Overview
## Project Information
- **Name**: [Project Name]
- **Version**: 1.0.0
- **Created**: [Date]
- **Last Updated**: [Date]
## Description
[Brief description of what this project does and its main purpose]
## Architecture Overview
[High-level architecture description]
### Key Components
- **Component 1**: [Description]
- **Component 2**: [Description]
- **Component 3**: [Description]
### Technology Stack
- **Language**: [Primary programming language]
- **Framework**: [Main framework if applicable]
- **Database**: [Database technology]
- **Testing**: [Testing framework]
- **Build Tool**: [Build system]
## Development Workflow
This project follows a **Test-Driven Development (TDD)** approach with the following stages:
1. **Analyze**: Understand requirements and break down into testable components
2. **Write Tests**: Create failing tests that define the expected behavior
3. **Implement**: Write minimal code to make tests pass
4. **Refactor**: Improve code quality while keeping tests green
## Project Structure
```
project-root/
├── src/ # Source code
├── tests/ # Test files
├── docs/ # Documentation
├── .devflow/ # Dev Flow configuration
│ ├── tasks.yaml # Task definitions
│ ├── state.json # Current state
│ └── workflows/ # Custom workflows
└── README.md # Project readme
```
## Getting Started
### Prerequisites
- [List required software/tools]
- [Minimum versions]
### Installation
```bash
# Clone the repository
git clone [repository-url]
# Install dependencies
[installation commands]
# Run tests
[test commands]
```
### Development Setup
1. Initialize Dev Flow: `devflow init`
2. Load TDD workflow: Use `load_workflow` with `tdd_strict`
3. Start first task: Use `get_next_task` and `start_task`
## Success Criteria
- [ ] All tests pass
- [ ] Code coverage > 80%
- [ ] No linting errors
- [ ] Documentation is complete
- [ ] Performance requirements met
## Notes
[Any additional notes, constraints, or important information]
---
*This file was generated by Dev Flow MCP. Update as needed for your specific project.*