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

📚 詳細文檔

文檔生成

項目文檔助手根據項目類型生成不同的文檔集：

與Cursor集成

1. 啟動項目文檔助手服務。
2. 在Cursor中配置MCP服務地址。
3. 開始享受增強的AI輔助開發體驗。

Q&A整合特性

項目文檔助手智能地將用戶與AI之間的交互整合到相關文檔中：

• 自動識別相關問答內容。
• 將有價值的信息添加到相應的文檔中。
• 保持結構化和可讀性的文檔。

🔧 技術細節

• Python 3.12+：作為主要的編程語言。
• argparse：用於命令行參數解析。
• Jinja2：作為模板引擎。
• MCP協議：用於與Cursor等AI工具集成。

🤝 貢獻

歡迎貢獻！請查閱我們的貢獻指南瞭解詳細信息。

📄 許可證

本項目採用MIT許可證，具體細節請參閱LICENSE文件。

💡 使用建議

項目文檔助手正在積極開發中，歡迎反饋和建議！