ProjectDocHelper

🚀 项目文档助手

项目文档助手是一款基于MCP（模型上下文协议）的服务器，它能够自动生成项目文档，并通过MCP让像Cursor这样的AI开发工具访问这些文档，有效提升AI回复的准确性与相关性。

🚀 快速开始

安装

pip install projectdochelper

基本用法

# 生成项目文档（简单模式）
projectdochelper generate --mode simple

# 生成项目文档（详细模式）
projectdochelper generate --mode detailed

# 启动MCP服务器
projectdochelper serve --port 8080

✨ 主要特性

• 🚀 智能文档生成：依据项目类型自动生成文档集。
• 🔄 多种生成模式：支持简单和详细两种模式，满足不同需求。
• 📊 进度可视化：在文档生成过程中显示进度条。
• 🔌 MCP服务支持：启动服务后，Cursor可以访问生成的文档。
• 📋 问答整合：支持将用户与AI之间的交互纳入文档中。

📦 安装指南

使用pip命令进行安装：

pip install projectdochelper

💻 使用示例

基础用法

# 生成项目文档（简单模式）
projectdochelper generate --mode simple

# 生成项目文档（详细模式）
projectdochelper generate --mode detailed

# 启动MCP服务器
projectdochelper serve --port 8080

📚 详细文档

文档生成

项目文档助手根据项目类型生成不同的文档集： | 项目类型 | 生成的文档 | |--------|---------| | 前端 | ProjectRequirements.md, FrontendGuidelines.md, TechStack.md | | 后端 | ProjectRequirements.md, BackendStructure.md, TechStack.md | | 全栈 | ProjectRequirements.md, FrontendGuidelines.md, BackendStructure.md, TechStack.md |

与Cursor集成

1. 启动项目文档助手服务。
2. 在Cursor中配置MCP服务地址。
3. 开始享受增强的AI辅助开发体验。

Q&A 整合特性

项目文档助手智能地将用户与AI之间的交互整合到相关文档中：

• 自动识别相关问答内容。
• 将有价值的信息添加到相应的文档中。
• 保持结构化和可读性的文档。

🔧 技术细节

• Python 3.12+：作为主要的编程语言。
• argparse：用于命令行参数解析。
• Jinja2：作为模板引擎。
• MCP协议：用于与Cursor等AI工具集成。

📄 许可证

本项目采用MIT许可证，具体细节请参阅LICENSE文件。

⚠️ 重要提示

项目文档助手正在积极开发中。

💡 使用建议

欢迎反馈和建议！若要贡献代码，请查阅我们的贡献指南了解详细信息。