NHL Stats

🚀 NHL API - 模型上下文协议

本项目是一个使用 TypeScript 实现的 NHL API，采用模型上下文协议（Model-Context Protocol）模式。借助此 MCP 服务器，用户能够轻松访问 NHL 数据，涵盖球队、球员、排名、赛程以及统计信息等方面。

🚀 快速开始

克隆仓库

git clone https://github.com/yourusername/repository.git
cd repository

安装依赖项

npm install

配置凭据

在项目根目录下创建 config.js 文件，并添加以下内容：

export const API_KEY = 'your_api_key';

启动服务器

npm run dev

✨ 主要特性

该库提供了简洁的接口，用于访问 NHL 的官方 API，并通过模型上下文协议（MCP）加以运用。它支持从 NHL 的 API 获取数据，并以结构化且易于使用的格式通过 MCP 工具提供。

📦 安装指南

克隆项目

git clone https://github.com/yourusername/repository.git
cd repository

安装依赖

npm install

配置 API 密钥

在项目根目录下创建 config.js 文件，添加 API 密钥：

export const API_KEY = 'your_api_key';

启动开发服务器

npm run dev

📚 详细文档

📊 当前状态

截至 2025 年 3 月 10 日，平台具备以下功能：

✅ 已实现的功能

1. 排名（Standings）
   • 提供联盟范围内的排名，包含分区细分情况。
   • 提供完整的球队记录信息。
2. 球队（Teams）
   • 提供基本的球队身份信息。
   • 提供当前阵容信息以及球员详情。
   • 提供球队统计数据（前锋和守门员）。
   • 支持新秀跟踪。
3. 球员（Players）
   • 提供球员个人背景信息。
   • 提供当季和职业生涯统计数据。
   • 提供球员的奖项荣誉信息。
4. 赛程（Schedules）
   • 提供当前球队赛程。
   • 提供特定日期的联盟赛程。
   • 提供即将进行的比赛信息。
5. 统计信息（Statistics）
   • 提供当前统计数据领先者（前锋和守门员）。
   • 提供球队特定的统计分析。
6. 比赛信息（Game Information）
   • 提供实时比赛分数和状态。
   • 提供比赛赛程。

❌ 已识别的问题

1. 球队信息缺口
   • 球队分区和赛区信息在球队查找中缺失。
   • 基本球队数据不完整（城市/位置细节缺失）。
2. 比赛详情
   • 进行中比赛的状态信息有限。
   • 比赛逐秒数据实现需要进一步测试。
3. 历史数据
   • 季节性历史数据访问需要验证。
   • 历史赛程检索需要额外测试。
4. UI 集成
   • 目前没有用于数据可视化的 UI 组件。
   • 原始数据格式需要转换以供前端显示。

📝 待办事项清单

高优先级

• [ ] 修复球队信息 API，使其包含完整的球队细节（分区、赛区、位置）。
• [ ] 实现更详细的实时比赛状态跟踪。
• [ ] 创建数据转换层用于 UI 集成。
• [ ] 完成历史数据端点测试。

中等优先级

• [ ] 开发标准的数据可视化组件。
• [ ] 添加球员图片集成。
• [ ] 实现球队标志/品牌资产。
• [ ] 创建所有数据类型的搜索功能。

低优先级

• [ ] 构建常用数据的缓存系统。
• [ ] 添加梦幻冰球积分点。
• [ ] 开发新闻/媒体整合。
• [ ] 添加社交媒体内容连接。

📖 API 参考

核心 API 端点

• 获取球队信息
  • URL: /api/teams
  • 方法: GET
  • 描述: 返回所有 NHL 球队的信息。
• 获取球员信息
  • URL: /api/players
  • 方法: GET
  • 描述: 返回所有 NHL 球员的信息。

🚀 贡献指南

欢迎为该项目做出贡献！请遵循以下步骤：

1. 为任何错误或改进创建问题。
2. 创建功能分支并提交更改。
3. 提交拉取请求以进行审查和合并。

💬 联系方式

如有任何问题，请联系 Your Name 或访问我们的 GitHub 仓库：GitHub 链接。

📄 许可证

该软件受 MIT 许可证的约束。有关详细信息，请参阅 LICENSE 文件。