Steamstats MCP

🚀 Steam Statistics Server Documentation

This documentation aims to provide a comprehensive guide to the Steam Statistics Server (SteamStats Server). This server is used to obtain various statistical information and data associated with the Valve Steam game platform.

🚀 Quick Start

⚠️ Important Note

The current implementation is not available!

✨ Features

• Retrieve the current number of online players for a game.
• Obtain application details for a specific game.
• Get the data schema of a game.
• Fetch game news.
• Retrieve player achievements.
• Obtain a user's game statistics.
• Get global game statistics.
• Retrieve the list of supported APIs.
• Obtain the application list.
• Get the global achievement percentages for a game.

🔧 Technical Details

The following are the main technologies used to build this server:

• Framework: FastAPI (for rapid development of high - performance web services).
• Runtime: Python 3.8+.
• Dependency Management: poetry (for package management).
• Logging: logging module (for recording server operation logs).

Request Flowchart

The following is a simplified request flowchart:

1. The client sends an HTTP request containing commands and parameters to the /message endpoint.
2. The server receives and parses the request.
3. Execute the corresponding database query or API call based on the request content.
4. Process the result and format it into a JSON response.
5. Return the response to the client.

📦 Installation

Environment Requirements

• Python version: 3.8 or higher.
• Operating System: Linux, macOS, or Windows (Linux is recommended for production - environment deployment).

Installation Steps

1. Clone this repository to your local development environment:

   git clone <repository-url>
   

2. Navigate to the project directory:

   cd steamstats-server
   

3. Install dependencies using poetry:

   poetry install
   

4. Start the server:

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

📚 Documentation

Configuration Guide

Environment Variables

The following are the key environment variables required to run the server:

• STEAM_API_KEY: Required. The key for accessing the Steam API.
• DB_URI: Optional. The URI for connecting to the database (if persistent storage is required).

Server Operation

1. Start the server:

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

2. Access the documentation: By default, FastAPI provides interactive API documentation at http://localhost:8000/docs.

Available Commands

The following are some currently implemented MCP (Game Data Exchange Protocol) commands:

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

For detailed information, please refer to the steamstats_mcpSpecification.md document.

Connecting a Local MCP Client (e.g., Roo)

1. Ensure the server is running.
2. Open the client's configuration file (usually located at .roo/mcp.json).
3. Add the following content:

   {
     "servers": [
       // Other server configurations...
       {
         "name": "steamstats-local",
         "type": "sse",
         "enabled": true,
         "url": "http://localhost:8000/message",
         "readTimeoutSeconds": 60,
         "writeTimeoutSeconds": 60
       }
     ]
   }
   

4. Save the file and restart the client.

We hope this guide helps you use the Steam Statistics Server smoothly!