项目文档助手
   ](https://github.com/stark1937/ProjectDocHelper)
📝 引言
ProjectDocHelper是一个MCP（模型上下文协议）服务器，旨在自动生成项目文档，并使其可通过MCP访问Cursor等AI开发工具，从而提高AI响应的准确性和相关性。
✨ 主要特点
- 🚀 智能文档生成：根据项目类型自动生成文档集
- 🔄 多代模式：支持简单和详细模式以满足不同需求
- 📊 进度可视化：在文档生成过程中显示进度条
- 🔌 MCP服务支持：服务启动后，游标可以访问生成的文档
- 📋 问答整合：支持将用户AI交互纳入文档
🛠️ 技术栈
- Python 3.12+
- argparse：命令行参数解析
- Jinja2：模板引擎
- MCP协议：与Cursor等人工智能工具集成
🚀 快速开始
安装
pip install projectdochelper基本用法
# 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📚 文档生成
ProjectDocHelper根据项目类型生成不同的文档集：
| 项目类型 | 生成的文档 |
|---|---|
| 前端 | 项目要求.md、前端指南.md、TechStack.md |
| 后端 | 项目要求.md、后端结构.md、TechStack.md |
| 全栈 | 项目要求.md、前端指南.md、后端结构.md、技术栈.md |
🔗 光标集成
- 启动ProjectDocHelper服务
- 在游标中配置MCP服务地址
- 开始享受增强的人工智能辅助开发
📋 问答集成功能
ProjectDocHelper智能地将用户AI交互集成到相关文档中：
- 自动识别相关问答内容
- 为相应文档添加有价值的信息
- 维护结构化和可读的文档
🤝 贡献
欢迎投稿！请查看我们的贡献指南以了解详细信息。
📄 许可证
此项目根据MIT许可证获得许可-有关详细信息，请参阅许可证文件。
💡 注意：ProjectDocHelper正在积极开发中。欢迎反馈和建议！