项目简介

Chat Royale MCP 服务器是整个 Chat Royale 应用的核心后端服务之一,专门用于将《部落冲突:皇室战争》的官方API封装成符合 Model Context Protocol (MCP) 标准的工具。通过这个服务器,大型语言模型 (LLM) 客户端可以安全、标准化地调用这些工具,获取玩家、部落、卡牌和排行榜等实时游戏数据,从而构建智能对话和分析应用。

主要功能点

  • 游戏数据工具: 提供一系列工具,可以查询《部落冲突:皇室战争》的玩家信息、部落详情、卡牌列表及排行榜数据。
  • MCP 标准接口: 遵循 Model Context Protocol (MCP) 规范,通过 JSON-RPC over Streamable HTTP 与 LLM 客户端通信。
  • 模块化设计: 将不同类型的游戏数据查询(如玩家、部落、卡牌、排名)封装在独立的Python模块中,易于扩展和维护。
  • API 密钥管理: 通过环境变量安全管理《部落冲突:皇室战争》API 密钥。

安装步骤

该项目是容器化的,推荐使用 Docker Compose 进行部署。

  1. 克隆仓库: 将 Chat Royale 仓库克隆到本地。
  2. 配置环境变量:
    • 在 'src/mcp/' 目录下创建 '.env' 文件,并设置 'CR_API_KEY' 为你的《部落冲突:皇室战争》API 密钥。例如:'CR_API_KEY=YOUR_CLASH_ROYALE_API_KEY'
  3. 构建并运行服务: 在仓库根目录下,执行以下命令来启动所有服务(包括 MCP 服务器):
    docker-compose up -d --build
    这将构建所有必要的 Docker 镜像并在后台运行服务。

服务器配置 (MCP客户端使用)

MCP客户端需要配置与此MCP服务器建立连接。以下是客户端可能需要的配置信息:

  • 服务器名称 (Server Name): 'Clash Royale MCP Server'
  • 命令 (Command): 'python'
  • 参数 (Arguments): '["src/main.py"]'
  • 工作目录 (Working Directory): MCP服务器的根目录 (通常是 'src/mcp/src/')
  • 传输协议 (Transport Protocol): 'Streamable HTTP'
  • 连接地址 (Connection URL): 'http://clash-royale-mcp-server:8000/mcp' (请注意,'clash-royale-mcp-server' 是 Docker Compose 内部的服务名称。如果从宿主机访问或在不同网络环境下,需替换为实际可达的IP地址和端口,例如 'http://localhost:8000/mcp')

基本使用方法

MCP 服务器启动后,LLM 客户端可以通过配置上述连接信息,连接到该服务器并发现其暴露的工具。一旦连接成功,LLM 客户端即可通过调用如 'search_clans'、'get_player_info'、'get_cards' 等工具来获取《部落冲突:皇室战争》的实时数据。例如,LLM 客户端可以请求查询特定部落的信息,MCP 服务器会执行 'get_clan_info' 工具并返回结果。

信息

分类

AI与计算