使用说明

项目简介

OP.GG 电竞 MCP 服务器是一个实现了 Model Context Protocol (MCP) 的后端应用,旨在将 OP.GG 丰富的电竞数据与 AI 智能体和平台连接起来。通过这个服务器,AI 智能体可以方便地获取英雄联盟 (League of Legends) 的赛事数据,例如即将到来的比赛日程和比赛信息。

主要功能点

  • 获取英雄联盟赛事信息: 提供 'get-lol-matches' 工具,允许 AI 智能体查询 OP.GG 电竞网站上即将到来的英雄联盟比赛日程。
  • 标准化数据接口: 通过 MCP 协议以标准化的 JSON-RPC 格式与客户端通信,方便集成到各种 MCP 客户端和 LLM 应用中。
  • 易于部署: 提供多种安装和运行方式,包括使用 Smithery、npm/pnpm 以及直接使用 Node.js 运行。
  • 示例请求: 提供清晰的请求示例,方便开发者快速上手使用服务器提供的工具。

安装步骤

  1. 环境准备: 确保你的机器上已安装 Node.js 和 npm 或 pnpm 包管理器。
  2. 安装依赖: 在项目根目录下运行 'pnpm install' 命令安装项目依赖。
  3. 构建项目: 运行 'pnpm build' 命令编译 TypeScript 代码到 'dist' 目录。

服务器配置

要将 OP.GG 电竞 MCP 服务器添加到 MCP 客户端的配置中,例如 Windsurf 的 'mcp_config.json' 文件,你需要配置服务器的启动命令和参数。以下是一个配置示例:

{
  "mcpServers": {
    "opgg-esports": {
      "command": "node",
      "args": ["/path/to/esports-mcp/dist/index.js"] // 请将 "/path/to/esports-mcp" 替换为你的 esports-mcp 项目的实际路径
    }
  }
}

配置说明:

  • '"opgg-esports"': 为该 MCP 服务器定义的名称,可以自定义。
  • '"command": "node"': 指定运行 MCP 服务器的命令为 'node',表示使用 Node.js 运行时环境。
  • '"args": ["/path/to/esports-mcp/dist/index.js"]': 指定传递给 'node' 命令的参数,这里是服务器入口文件 'dist/index.js' 的路径。请务必将 '/path/to/esports-mcp' 替换为你本地 esports-mcp 项目的实际文件路径。

基本使用方法

OP.GG 电竞 MCP 服务器通过标准输入 (stdio) 接收客户端的 JSON-RPC 请求,并通过标准输出 (stdio) 返回 JSON-RPC 响应。你可以使用任何 MCP 兼容的客户端与之通信。

常用请求示例:

  • 列出可用工具: 发送以下 JSON 请求到服务器的标准输入,即可获取服务器提供的工具列表。
{ "type": "list_tools" }
  • 调用工具获取英雄联盟比赛: 发送以下 JSON 请求调用 'get-lol-matches' 工具,获取即将到来的英雄联盟比赛日程。
{
  "type": "tool_call",
  "tool_call": {
    "name": "get-lol-matches"
  }
}

服务器会将查询结果以 JSON 格式通过标准输出返回。具体的返回内容请参考仓库 README.md 中的示例。

信息

分类

网页与API