Lol Client MCP

🚀 LoL 客户端 MCP 服务器

这是一个用于访问《英雄联盟》（League of Legends）客户端数据的 MCP（模型 - 控制器 - 处理器）服务器。它提供了一系列工具，通过与《英雄联盟》实时客户端数据 API 通信，帮助用户检索游戏内数据。

🚀 快速开始

该项目借助《英雄联盟》游戏客户端的实时客户端数据 API 来访问实时游戏数据。它利用 FastMCP 框架，将各种端点作为工具公开。

API 相关信息可参考 👉 Riot Games 开发者文档。

📦 安装指南

先决条件

• Python 3.8 或更高版本
• uv - 快速且可靠的 Python 包管理器
  • 安装命令：pip install uv
• 已安装的《英雄联盟》客户端

项目设置

1. 克隆此仓库：

git clone https://github.com/yourusername/lol-client-mcp.git
cd lol-client-mcp

2. 使用 uv 安装所需包：

uv pip install httpx fastmcp

运行 MCP 服务器

直接运行：

python main.py

与 Claude 集成

有以下两种方式使用此项目与 Claude 结合：

1. Claude Desktop 配置

将以下内容添加到 claude_desktop_config.json 文件中：

{
    "mcpServers": {
        "lol-client-mcp": {
            "command": "uv",
            "args": [
                "--directory",
                "C:\\ABSOLUTE\\PATH\\TO\\PARENT\\FOLDER\\lol-client-mcp",
                "run",
                "main.py"
            ]
        }
    }
}

⚠️ 重要提示

请将 C:\\ABSOLUTE\\PATH\\TO\\PARENT\\FOLDER\\lol-client-mcp 替换为您实际项目的路径。

2. 与 Web 应用结合使用

要将 MCP 服务器连接到 Claude 网页应用：

1. 运行 MCP 服务器：

python main.py

2. 在 Claude 网页界面中配置服务器连接：
   • 开始对话时在底部进入 MCP 设置
   • 选择 'lol-client-mcp' 并连接

💻 使用示例

基础用法

以下是一些常用 API 工具的调用示例：

# 获取所有游戏数据
all_game_data = get_all_game_data()

# 获取游戏基本数据
game_stats = get_game_stats()

# 获取当前玩家的所有数据
active_player = get_active_player()

高级用法

# 获取指定玩家的物品列表
riot_id = "example_riot_id"
player_items = get_player_items(riot_id)

# 获取指定玩家当前的游戏得分列表
player_scores = get_player_scores(riot_id)

📚 详细文档

API 工具列表

游戏数据

• get_all_game_data(): 《英雄联盟》实时客户端数据 API 有多个端点，这些端点返回 /allgamedata 端点响应的一部分。此端点适合测试实时客户端数据 API，但除非您确实需要从该端点获取所有数据，建议使用以下列出的其他端点之一。
• get_game_stats(): 获取游戏的基本数据。
• get_event_data(): 获取游戏中发生的一系列事件。

当前玩家数据

• get_active_player(): 获取当前玩家的所有数据。
• get_active_player_name(): 返回玩家名称。
• get_active_player_abilities(): 获取当前玩家的技能信息。
• get_active_player_runes(): 获取当前玩家的完整符文列表。

玩家列表和单个玩家数据

• get_player_list(): 获取游戏中的英雄及其状态列表。
• get_player_scores(riot_id): 获取指定玩家当前的游戏得分列表。
• get_player_summoner_spells(riot_id): 获取指定玩家的召唤师技能列表。
• get_player_main_runes(riot_id): 获取任意玩家的主要符文信息。
• get_player_items(riot_id): 获取指定玩家的物品列表。

🔧 技术细节

问题排查

• 连接错误：检查《英雄联盟》客户端是否正在运行。
• 超时错误：确认游戏已经实际开始。此 API 在游戏大厅中不起作用。

注意事项

⚠️ 重要提示

此 API 只能在《英雄联盟》客户端运行且游戏正在进行时使用。使用时请遵守 Riot Games API 的相关政策。

📄 许可证

所有权利归 Riot Games 所有。