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 文件。