使用说明

项目简介

nhl-mcp 是一个使用 Model Context Protocol (MCP) 框架构建的服务器,旨在通过标准化的 MCP 协议,向客户端应用提供美国国家冰球联盟 (NHL) 的实时和历史数据。该服务器封装了 NHL 官方 API,并将其功能以 MCP 工具的形式暴露出来,方便 LLM 应用集成和调用。

主要功能点

  • 球队数据查询: 获取球队基本信息、球员阵容、球队统计数据和新秀信息。
  • 球员数据查询: 查询球员的个人资料、赛季和职业生涯统计数据、所获荣誉等。
  • 赛程和比分: 获取联赛和球队的赛程安排、实时比分和比赛状态。
  • 积分榜: 查询当前 NHL 联赛的积分榜,包括分区和联盟排名。
  • 统计数据: 获取当前赛季的球员和守门员的统计数据排行榜。

安装步骤

  1. 克隆仓库到本地:
    git clone https://github.com/dylangroos/nhl-mcp.git
  2. 进入项目目录:
    cd nhl-mcp
  3. 安装依赖:
    npm install
  4. 配置 API 凭证(如果需要,根据 '.env.example' 文件创建 '.env' 文件并编辑 API 密钥,但本项目似乎无需API密钥)

服务器配置

{
  "serverName": "nhl-mcp",
  "command": "node",
  "args": [ "dist/server.js" ],
  "description": "启动 NHL API MCP 服务器"
}

配置信息参数说明:

  • 'serverName': 服务器名称,可以自定义,例如 "nhl-mcp"。
  • 'command': 启动服务器的命令,这里使用 'node' 运行 JavaScript 代码。
  • 'args': 传递给 'node' 命令的参数,'dist/server.js' 是编译后的服务器入口文件。
  • 'description': 服务器配置的简要描述,方便识别服务器用途。

基本使用方法

  1. 启动 MCP 服务器:在项目根目录下运行 'npm run dev' 或 'npm start' (实际运行 'npm start' 会执行 'node dist/server.js')。
  2. 使用 MCP 客户端 (如 ModelScope Agent 或其他 MCP 客户端) 连接到该服务器。
  3. 通过客户端调用服务器提供的工具,例如:
    • 查询球队信息: 调用 'get-team' 工具,参数为 'teamAbbrev' (球队缩写,如 'TOR')。
    • 查询球员数据: 调用 'get-player-landing' 工具,参数为 'playerId' (球员 ID,如 8478402)。
    • 查询当前积分榜: 调用 'get-current-standings' 工具,无需参数。
  4. 服务器将返回 JSON-RPC 响应,客户端解析响应内容并展示 NHL 数据。

信息

分类

网页与API