使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,专门为云顶之弈 (Teamfight Tactics, TFT) 游戏设计。它允许LLM客户端通过标准化的MCP协议,调用预设的工具来获取TFT游戏数据。

主要功能点

  • 获取玩家对局历史: 查询指定玩家的云顶之弈对局历史记录,可以指定返回的对局数量和起始位置。
  • 获取对局详情: 查询指定对局ID的详细信息,包括参与者、游戏时长、段位变化等。

安装步骤

  1. 克隆仓库:将仓库 'https://github.com/GeLi2001/tft-mcp-server' 克隆到本地。
  2. 安装依赖:在项目根目录下,打开终端并运行 'npm install' 或 'yarn install' 安装项目依赖。
  3. 获取Riot Games API Key:访问 Riot Games Developer Portal 并申请一个API Key。请注意,开发期间可以使用临时API Key,但生产环境需要申请永久API Key。
  4. 获取游戏ID和Tagline:登录你的Riot Games客户端,在个人资料中找到你的游戏名称 (Game Name) 和 Name Tagline (通常在游戏名称后显示,例如 'NA1')。

服务器配置

要将此MCP服务器配置到支持MCP协议的客户端(例如 Claude Desktop),你需要编辑客户端的配置文件。以 Claude Desktop 为例,你需要修改 'claude_desktop_config.json' 文件,添加 'mcpServers' 配置项。

配置文件路径:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容:

在 'mcpServers' 字段下添加一个新的服务器配置,例如 'tft-mcp'。配置信息如下:

{
  "mcpServers": {
    "tft-mcp": {
      "command": "npx",
      "args": [
        "mcp-server-tft",
        "--apiKey",
        "<YOUR_RIOT_API_KEY>",  // 替换为你的Riot API Key
        "--gameName",
        "<YOUR_GAME_NAME>",    // 替换为你的游戏名称 (Game Name)
        "--tagLine",
        "<YOUR_TAG_LINE>"     // 替换为你的Name Tagline
      ]
    }
  }
}

参数说明:

  • 'command': 启动服务器的命令,这里使用 'npx mcp-server-tft',确保你的环境中可以执行 'npx' 命令,并且已经安装了项目依赖。
  • 'args': 传递给服务器的命令行参数,包括:
    • '--apiKey': 你的Riot Games API Key。
    • '--gameName': 你的游戏名称 (Game Name)。
    • '--tagLine': 你的Name Tagline。

基本使用方法

  1. 启动服务器:在项目根目录下,打开终端并运行命令 'npm start -- --apiKey <YOUR_RIOT_API_KEY> --gameName <YOUR_GAME_NAME> --tagLine <YOUR_TAG_LINE>' (请替换尖括号中的内容)。或者,你可以直接使用配置文件中配置的 'command' 和 'args',Claude Desktop 等 MCP 客户端会自动启动配置的MCP服务器。
  2. 在MCP客户端中使用工具:配置完成后,在支持MCP协议的客户端中,你应该能够看到名为 'tft_match_history' 和 'tft_match_details' 的工具。
    • 'tft_match_history' 工具: 用于获取对局历史。可以设置可选参数 'count' (获取对局数量,默认为20) 和 'start' (起始索引,默认为0)。
    • 'tft_match_details' 工具: 用于获取指定对局ID的详细信息。需要提供参数 'matchId' (对局ID)。

客户端会通过MCP协议与服务器通信,调用这些工具并获取返回的JSON格式的游戏数据。

信息

分类

网页与API