Waifu Queue

🚀 MCP Waifuキュー

MCP Waifuキューは、特定のタスクを管理するためのバックエンドシステムです。Gemini APIを利用したテキスト生成タスクをキュー管理し、効率的に実行できます。

🚀 クイックスタート

以下の手順を参照して、MCP Waifuキューをセットアップしてください。

📦 インストール

コードリポジトリの取得

git clone https://github.com/your-username/mcp_waifu_queue.git
cd mcp_waifu_queue

依存関係のインストール

Python仮想環境を作成してアクティブ化し、次にプロジェクトの依存関係をインストールします。

pip install -r requirements.txt

🔧 環境設定

プロジェクトのルートディレクトリに.envファイルを作成し、以下の内容を追加します。

REDIS_URL=redis://localhost:6379/0

💻 使用例

バックグラウンドタスクキュー

ワーカープロセスの起動

python -m mcp_waifu_queue.worker

MCPサーバーの起動

uvicorn mcp_waifu_queue.main:app --reload --port 8000

または、Linux/macOSの場合は以下のスクリプトを使用できます。

./scripts/start-services.sh

📚 ドキュメント

MCP APIインターフェース

ツール

• generate_text
  • 説明：Gemini APIにテキスト生成リクエストを送信します。
  • 入力：{"prompt": "あなたのテキストプロンプト内容"}（タイプ：GenerateTextRequest）
  • 出力：{"job_id": "rq:job:..."}（一意のタスクID）

リソース

• job://{job_id}
  • 説明：以前に送信したタスクの状態と結果を取得します。
  • パスパラメータ：job_id（generate_textツールから返されるタスクID）。
  • 出力：{"status": "...", "result": "..."}（タイプ：JobStatusResponse）
    • status：タスクの現在の状態（例："queued"、"started"、"finished"、"failed"）。RQ内部では異なる用語が使用され、リソースがマッピングされます。
    • result：タスクの状態が"completed"の場合、生成されたテキストが含まれます。それ以外の場合はnullです。タスクが失敗した場合、結果はnullまたはエラーメッセージが含まれる場合があります。

🧪 テスト

プロジェクトにはテストケースが含まれています。テスト依存関係をインストールしてから、テストを実行してください。

pip install -e .[test]

テストの実行：

pytest tests

注意：テストでは、fakeredisを使用してRedisをモックし、Gemini API呼び出しをモックする場合があります。

⚠️ トラブルシューティング

• エラー：Gemini APIキーが.../.api-geminiまたはGEMINI_API_KEY環境変数に見つかりません：~/.api-geminiファイルに有効なGemini APIキーが存在すること、またはGEMINI_API_KEY環境変数が設定されていることを確認してください。
• Gemini API呼び出しエラー（例：AuthenticationError、PermissionDenied）：~/.api-geminiのAPIキーが正しく有効であることを確認してください。APIがあなたのGoogle Cloudプロジェクトで有効になっていることを確認してください。
• タスクが"queued"状態で止まっている：別のターミナルでRQワーカー（python -m mcp_waifu_queue.worker）が実行されており、.envファイルで指定された同じRedisインスタンスに接続されていることを確認してください。ワーカーのログを確認してエラー情報を取得してください。
• 接続拒否エラー（Redis）：Redisサーバーが実行されており、.envファイルで指定されたREDIS_URLでアクセスできることを確認してください。
• MCPサーバー接続問題：MCPサーバー（uvicorn ...）が実行されており、正しいホストとポートに接続されていることを確認してください。

🤝 コントリビューションガイド

コードリポジトリの取得

• プロジェクトリポジトリをForkします。
• 機能または修正ブランチを作成します。

git checkout -b feature/your-feature-name

変更のコミット

git add .
git commit -m "機能追加：あなたの機能の説明"
git push origin feature/your-feature-name

プルリクエストの作成

GitHubでプロジェクトの「Pull Request」ページに移動し、プルリクエストを提出します。

📝 コード規約

• PEP8コーディング規約に従ってください。
• 意味のある変数名と関数名を使用してください。
• コードのコメントを明確にしてください。

📄 ライセンス

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

MCP Waifuキューをご利用いただき、ありがとうございます！何か問題があれば、メンテナにお問い合わせください。