蒸汽统计数据服务器文档

注意

当前实现不可用！

概述

此文档旨在提供关于蒸汽统计数据服务器（SteamStats Server）的全面指南。该服务器用于获取与Valve Steam游戏平台相关联的各种统计信息和数据。

核心功能

• 获取游戏的当前在线玩家数量。
• 获取特定游戏的应用详情。
• 获取游戏的数据架构。
• 获取游戏新闻。
• 获取玩家成就。
• 获取用户的游戏统计数据。
• 获取游戏的全球统计数据。
• 获取支持的API列表。
• 获取应用列表。
• 获取游戏的全球成就百分比。

技术栈

以下是构建此服务器所使用的主要技术：

• 框架: FastAPI（用于快速开发高性能的Web服务）。
• 运行时: Python 3.8+。
• 依赖管理: poetry（用于包管理）。
• 日志记录: logging模块（用于记录服务器操作日志）。

请求流程图

以下是一个简化的请求流程图：

1. 客户端发送包含命令和参数的HTTP请求到/message端点。
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. 保存文件并重新启动客户端。

希望本指南能帮助您顺利使用蒸汽统计数据服务器！