使用说明
NHL API-模型上下文协议
使用Model-Context协议模式的NHL API的TypeScript实现。此MCP服务器提供对NHL数据的访问,包括球队、球员、排名、时间表和统计数据。
概述
该库使用模型上下文协议(MCP)为NHL的官方API提供了一个干净的接口。它允许您从NHL的API中获取数据,并通过MCP工具以结构化、易于使用的格式提供数据。
📊 当前状态
截至2025年3月10日,该平台提供以下功能:
✅ 工作特点
-
支架
- 按赛区划分的联盟排名
- 完整的团队记录信息
-
团队
- 基本团队身份信息
- 包含球员详细信息的当前名册信息
- 团队统计数据(滑冰运动员和守门员)
- 潜在客户跟踪
-
玩家
- 球员履历信息
- 当前赛季和职业统计
- 奖项表彰
-
日程表
- 当前团队日程
- 特定日期的联赛时间表
- 即将到来的游戏信息
-
统计
- 当前的统计领导者(滑冰运动员和守门员)
- 团队特定统计细分
-
游戏信息
- 实时游戏分数和状态
- 游戏时间表
❌ 发现的问题
-
团队信息差距
- 团队查找中缺少团队划分和会议信息
- 基本团队数据不完整(缺少城市/位置详细信息)
-
游戏详情
- 正在进行的游戏的有限游戏状态信息
- 逐个播放数据实现需要进一步测试
-
历史数据
- 季节性历史数据访问需要验证
- 历史进度检索需要额外的测试
-
UI集成
- 当前没有用于数据可视化的UI组件
- 原始数据格式需要转换以用于前端显示
📝 待办事项列表
高优先级
- []修复团队信息API,以包括完整的团队详细信息(部门、会议、地点)
- []为实时游戏实施更详细的游戏状态跟踪
- []为UI集成创建数据转换层
- []完成历史数据端点的测试
中优先级
- []开发标准数据可视化组件
- []添加玩家图像集成
- []实施团队徽标/品牌资产
- []在所有数据类型中创建搜索功能
低优先级
- []为频繁访问的数据构建缓存系统
- []添加幻想冰球积分
- []发展新闻/媒体整合
- []添加社交媒体内容连接
🚀 入门指南
-
克隆存储库:
git clone https://github.com/yourusername/nhl-mcp.git cd nhl-mcp -
安装依赖项:
npm install -
配置API凭据:
cp .env.example .env # Edit .env with your API keys -
启动开发服务器:
npm run dev
🔧 api参考
NHL-MCP平台提供以下核心API端点:
团队
get-team:检索基本团队信息get-team-roster:获取当前球队名单get-team-stats:获取团队统计数据get-team-prospects:获取团队潜在客户信息
玩家
get-player-landing:获取详细的玩家信息
支架
get-current-standings:获取当前NHL排名
日程
get-schedule:获取一般日程信息get-current-schedule:获取团队即将到来的日程安排get-date-schedule:获取特定日期的日程安排
统计
get-current-stat-leaders:获取当前的统计领导者get-current-goalie-leaders:获取当前守门员统计领导者
游戏
get-scores-now:获取当前分数和游戏状态
📄 许可证
此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件。
🤝 贡献
欢迎投稿!请随时提交拉取请求。
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
📞 联系
项目维护者:Dylan Groos
注:本自述文件记录了基于2025年3月10日进行的测试的NHL-MCP项目的当前状态。该平台访问NHL数据,这些数据受国家冰球联盟设定的条款和条件的约束。