Steamstats MCP

🚀 スチーム統計データサーバードキュメント

このドキュメントは、ValveのSteamゲームプラットフォームに関連する様々な統計情報やデータを取得するためのSteamStats Serverについて、包括的なガイドを提供することを目的としています。

🚀 クイックスタート

このサーバーを使用することで、Steamゲームの様々な統計情報を取得できます。以下に、基本的な使い方を説明します。

✨ 主な機能

• ゲームの現在のオンラインプレイヤー数を取得します。
• 特定のゲームのアプリ詳細を取得します。
• ゲームのデータ構造を取得します。
• ゲームのニュースを取得します。
• プレイヤーの実績を取得します。
• ユーザーのゲーム統計データを取得します。
• ゲームのグローバル統計データを取得します。
• サポートされているAPIのリストを取得します。
• アプリのリストを取得します。
• ゲームのグローバル実績パーセンテージを取得します。

🔧 技術詳細

このサーバーを構築するために使用される主な技術は以下の通りです。

リクエストフローチャート

以下は、簡略化されたリクエストフローチャートです。

1. クライアントが/messageエンドポイントにコマンドとパラメータを含むHTTPリクエストを送信します。
2. サーバーがリクエストを受信して解析します。
3. リクエスト内容に応じて、対応するデータベースクエリまたはAPI呼び出しを実行します。
4. 結果を処理し、JSONレスポンスに整形します。
5. レスポンスをクライアントに返します。

📦 インストール

環境要件

• Pythonバージョン：3.8以上
• オペレーティングシステム：Linux、macOSまたはWindows（本番環境でのデプロイにはLinuxの使用を推奨）

インストール手順

1. このリポジトリをローカル開発環境にクローンします。

   git clone <repository-url>
   

2. プロジェクトディレクトリに移動します。

   cd steamstats-server
   

3. poetryを使用して依存関係をインストールします。

   poetry install
   

4. サーバーを起動します。

   poetry run uvicorn main:app --host $HOST --port $PORT --reload
   

📚 ドキュメント

環境変数

サーバーを実行するために必要な主要な環境変数は以下の通りです。

• STEAM_API_KEY：必須。Steam APIにアクセスするためのキーです。
• DB_URI：オプション。データベースに接続するためのURI（永続的なストレージが必要な場合）。

サーバーの実行

1. サーバーを起動します。

   uvicorn main:app --host $HOST --port $PORT --reload
   

2. デフォルトでは、FastAPIがhttp://localhost:8000/docsにインタラクティブなAPIドキュメントを提供します。

利用可能なコマンド

以下は、現在実装されているMCP（ゲームデータ交換プロトコル）コマンドです。

• getCurrentPlayers
• getAppDetails
• getGameSchema
• getGameNews
• getPlayerAchievements
• getUserStatsForGame
• getGlobalStatsForGame
• getSupportedApiList
• getAppList
• getGlobalAchievementPercentages

詳細情報については、steamstats_mcpSpecification.mdドキュメントを参照してください。

ローカルMCPクライアント（例：Roo）の接続

1. サーバーが起動していることを確認します。
2. クライアントの設定ファイル（通常は.roo/mcp.json）を開きます。
3. 以下の内容を追加します。

   {
     "servers": [
       // 他のサーバー設定...
       {
         "name": "steamstats-local",
         "type": "sse",
         "enabled": true,
         "url": "http://localhost:8000/message",
         "readTimeoutSeconds": 60,
         "writeTimeoutSeconds": 60
       }
     ]
   }
   

4. ファイルを保存し、クライアントを再起動します。

⚠️ 重要な注意事項

現在の実装は使用できません！