Projectdochelper

🚀 プロジェクトドキュメントヘルパー

English | 简体中文

🚀 クイックスタート

プロジェクトドキュメントヘルパーは、MCP（モデルコンテキストプロトコル）に基づくサーバーです。このサーバーは、自動的にプロジェクトドキュメントを生成し、MCPを通じてCursorなどのAI開発ツールからアクセスできるようにし、AIの回答の精度と関連性を向上させます。

✨ 主な機能

• 🚀 スマートなドキュメント生成：プロジェクトのタイプに応じて自動的にドキュメントセットを生成します。
• 🔄 複数の生成モード：簡易モードと詳細モードの2種類をサポートし、さまざまなニーズに対応します。
• 📊 進捗の可視化：ドキュメント生成中に進捗バーを表示します。
• 🔌 MCPサービスのサポート：サービスを起動すると、Cursorから生成されたドキュメントにアクセスできます。
• 📋 Q&Aの統合：ユーザーとAIのやり取りをドキュメントに組み込むことをサポートします。

📦 インストール

pip install projectdochelper

💻 使用例

基本的な使用法

# プロジェクトドキュメントを生成する（簡易モード）
projectdochelper generate --mode simple

# プロジェクトドキュメントを生成する（詳細モード）
projectdochelper generate --mode detailed

# MCPサーバーを起動する
projectdochelper serve --port 8080

📚 ドキュメント

プロジェクトドキュメントヘルパーは、プロジェクトのタイプに応じて異なるドキュメントセットを生成します。

🔧 技術詳細

• Python 3.12+
• argparse：コマンドライン引数の解析
• Jinja2：テンプレートエンジン
• MCPプロトコル：CursorなどのAIツールとの統合

🔗 Cursorとの統合

1. プロジェクトドキュメントヘルパーのサービスを起動します。
2. CursorでMCPサービスのアドレスを設定します。
3. 強化されたAI支援開発体験を楽しみましょう。

📋 Q&Aの統合機能

プロジェクトドキュメントヘルパーは、ユーザーとAIのやり取りを関連するドキュメントにスマートに統合します。

• 関連するQ&A内容を自動的に識別します。
• 価値のある情報を対応するドキュメントに追加します。
• ドキュメントの構造化と読みやすさを維持します。

🤝 コントリビューション

コントリビューションを歓迎します！詳細については、コントリビューションガイドを参照してください。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細については、LICENSEファイルを参照してください。

💡 使用アドバイス

プロジェクトドキュメントヘルパーは現在積極的に開発中です。フィードバックや提案を歓迎します！