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.
Stark1937
README
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!
Recommended Servers
Crypto Price & Market Analysis MCP Server
A Model Context Protocol (MCP) server that provides comprehensive cryptocurrency analysis using the CoinCap API. This server offers real-time price data, market analysis, and historical trends through an easy-to-use interface.
MCP PubMed Search
Server to search PubMed (PubMed is a free, online database that allows users to search for biomedical and life sciences literature). I have created on a day MCP came out but was on vacation, I saw someone post similar server in your DB, but figured to post mine.
dbt Semantic Layer MCP Server
A server that enables querying the dbt Semantic Layer through natural language conversations with Claude Desktop and other AI assistants, allowing users to discover metrics, create queries, analyze data, and visualize results.
mixpanel
Connect to your Mixpanel data. Query events, retention, and funnel data from Mixpanel analytics.
Sequential Thinking MCP Server
This server facilitates structured problem-solving by breaking down complex issues into sequential steps, supporting revisions, and enabling multiple solution paths through full MCP integration.
Nefino MCP Server
Provides large language models with access to news and information about renewable energy projects in Germany, allowing filtering by location, topic (solar, wind, hydrogen), and date range.
Vectorize
Vectorize MCP server for advanced retrieval, Private Deep Research, Anything-to-Markdown file extraction and text chunking.
Mathematica Documentation MCP server
A server that provides access to Mathematica documentation through FastMCP, enabling users to retrieve function documentation and list package symbols from Wolfram Mathematica.
kb-mcp-server
An MCP server aimed to be portable, local, easy and convenient to support semantic/graph based retrieval of txtai "all in one" embeddings database. Any txtai embeddings db in tar.gz form can be loaded
Research MCP Server
The server functions as an MCP server to interact with Notion for retrieving and creating survey data, integrating with the Claude Desktop Client for conducting and reviewing surveys.