NHL Stats

🚀 NHL API - Model Context Protocol

An NHL API implemented in TypeScript, following the Model-Context Protocol (MCP) pattern. This MCP server provides access to NHL data, including teams, players, standings, schedules, and statistics.

📋 Overview

This library offers a clean interface to access the official NHL APIs and utilize them through the Model-Context Protocol (MCP). It allows you to retrieve data from the NHL APIs and present it in a structured and user-friendly format via MCP tools.

📊 Current Status

As of March 10, 2025, the platform offers the following features:

✅ Implemented Features

1. Standings

   • League-wide standings, including division breakdowns
   • Complete team record information

2. Teams

   • Basic team identity information
   • Current roster information and player details
   • Team statistics (forwards and goalies)
   • Rookie tracking

3. Players

   • Player personal background information
   • Current season and career statistics
   • Awards and honors

4. Schedules

   • Current team schedules
   • League schedules for specific dates
   • Information on upcoming games

5. Statistics

   • Current statistical leaders (forwards and goalies)
   • Team-specific statistical analysis

6. Game Information

   • Real-time game scores and status
   • Game schedules

❌ Identified Issues

1. Team Information Gaps

   • Team division and conference information is missing in team lookups
   • Basic team data is incomplete (missing city/location details)

2. Game Details

   • Limited status information for ongoing games
   • Implementation of game-by-second data requires further testing

3. Historical Data

   • Access to seasonal historical data needs verification
   • Retrieval of historical schedules requires additional testing

4. UI Integration

   • There are currently no UI components for data visualization
   • Raw data formats need to be converted for front-end display

📝 To-Do List

High Priority

• [ ] Fix the team information API to include complete team details (division, conference, location)
• [ ] Implement more detailed real-time game status tracking
• [ ] Create a data transformation layer for UI integration
• [ ] Complete testing of historical data endpoints

Medium Priority

• [ ] Develop standard data visualization components
• [ ] Add player picture integration
• [ ] Implement team logos/brand assets
• [ ] Create a search function for all data types

Low Priority

• [ ] Build a caching system for commonly used data
• [ ] Add fantasy hockey points
• [ ] Develop news/media integration
• [ ] Add social media content connections

🚀 Quick Start

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Configure credentials:

   • Create a config.js file in the project root directory and add the following:

     export const API_KEY = 'your_api_key';
     

4. Start the server:

   npm run dev
   

📚 Documentation

Core API Endpoints

• Get Team Information

  • URL: /api/teams
  • Method: GET
  • Description: Returns information for all NHL teams.

• Get Player Information

  • URL: /api/players
  • Method: GET
  • Description: Returns information for all NHL players.

📄 License

This software is licensed under the MIT License. For more details, please refer to the LICENSE file.

🤝 Contribution Guidelines

Contributions to this project are welcome! Please follow these steps:

1. Create an issue for any bugs or improvements.
2. Create a feature branch and submit your changes.
3. Submit a pull request for review and merging.

💬 Contact

If you have any questions, please contact Your Name or visit our GitHub repository: GitHub Link.