ProjectDocHelper
ProjectDocHelper is an MCP (Model Context Protocol) server designed to automatically generate project documentation and make it accessible to AI development tools like Cursor through MCP, thereby improving the accuracy and relevance of AI responses.
what is ProjectDocHelper?
ProjectDocHelper is an MCP (Model Context Protocol) server designed to automatically generate project documentation and make it accessible to AI development tools like Cursor, thereby improving the accuracy and relevance of AI responses.
how to use ProjectDocHelper?
To use ProjectDocHelper, install it via pip and run commands to generate documentation in either simple or detailed mode, and start the MCP server to allow AI tools to access the generated documents.
key features of ProjectDocHelper?
- Smart Documentation Generation: Automatically generates document sets based on project type.
- Multiple Generation Modes: Supports both simple and detailed modes for different needs.
- Progress Visualization: Displays a progress bar during document generation.
- MCP Service Support: Cursor can access generated documents after service startup.
- Q&A Integration: Supports incorporating user-AI interactions into documentation.
use cases of ProjectDocHelper?
- Automatically generating documentation for frontend, backend, or full-stack projects.
- Enhancing AI-assisted development by providing relevant documentation to AI tools.
- Integrating user interactions into project documentation for better context.
FAQ from ProjectDocHelper?
- Can ProjectDocHelper generate documentation for all project types?
Yes! It generates tailored documentation sets for frontend, backend, and full-stack projects.
- Is ProjectDocHelper free to use?
Yes! ProjectDocHelper is open-source and free to use.
- How does the Q&A integration work?
It intelligently identifies relevant Q&A content and adds it to the corresponding documents.
ProjectDocHelper
📝 Introduction
ProjectDocHelper is an MCP (Model Context Protocol) server designed to automatically generate project documentation and make it accessible to AI development tools like Cursor through MCP, thereby improving the accuracy and relevance of AI responses.
✨ Key Features
- 🚀 Smart Documentation Generation: Automatically generates document sets based on project type
- 🔄 Multiple Generation Modes: Supports both simple and detailed modes for different needs
- 📊 Progress Visualization: Displays progress bar during document generation
- 🔌 MCP Service Support: Cursor can access generated documents after service startup
- 📋 Q&A Integration: Supports incorporating user-AI interactions into documentation
🛠️ Tech Stack
- Python 3.12+
- argparse: Command-line argument parsing
- Jinja2: Template engine
- MCP Protocol: Integration with AI tools like Cursor
🚀 Quick Start
Installation
pip install projectdochelper
Basic Usage
# Generate project documentation (simple mode)
projectdochelper generate --mode simple
# Generate project documentation (detailed mode)
projectdochelper generate --mode detailed
# Start MCP server
projectdochelper serve --port 8080
📚 Document Generation
ProjectDocHelper generates different document sets based on project type:
| Project Type | Generated Documents |
|---|---|
| Frontend | ProjectRequirements.md, FrontendGuidelines.md, TechStack.md |
| Backend | ProjectRequirements.md, BackendStructure.md, TechStack.md |
| Full Stack | ProjectRequirements.md, FrontendGuidelines.md, BackendStructure.md, TechStack.md |
🔗 Cursor Integration
- Start ProjectDocHelper service
- Configure MCP service address in Cursor
- Start enjoying enhanced AI-assisted development
📋 Q&A Integration Feature
ProjectDocHelper intelligently integrates user-AI interactions into relevant documentation:
- Automatically identifies relevant Q&A content
- Adds valuable information to corresponding documents
- Maintains structured and readable documentation
🤝 Contributing
Contributions are welcome! Please check out our Contributing Guide for details.
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
💡 Note: ProjectDocHelper is under active development. Feedback and suggestions are welcome!