Streamersonglist MCP

🚀 StreamerSongList MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with StreamerSongList APIs. This server enables AI assistants like Claude to manage song requests, monitor queues, and interact with streaming platforms' song request systems.

🚀 Quick Start

Prerequisites

• Node.js (version 18 or higher)
• Claude Desktop or another MCP-compatible client

Installation

Option 1: Using npx (Recommended)

No installation required! Just configure Claude Desktop to use:

{
  "mcpServers": {
    "streamersonglist": {
      "command": "npx",
      "args": ["streamersonglist-mcp"]
    }
  }
}

Option 2: Local Installation

1. Clone this repository:

   git clone https://github.com/vuvuvu/streamersonglist-mcp.git
   cd streamersonglist-mcp
   

2. Install dependencies:

   npm install
   

3. Test the server:

   npm test
   

Installing via Smithery

To install streamersonglist-mcp for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @vuvuvu/streamersonglist-mcp --client claude

Usage with Claude Desktop

Quick Setup (npx method)

1. Find your Claude Desktop config file:
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json
2. Add the server to your config:

   {
     "mcpServers": {
       "streamersonglist": {
         "command": "npx",
         "args": ["streamersonglist-mcp"]
       }
     }
   }
   

3. Restart Claude Desktop
4. Test it out: Ask Claude: "Use the getStreamerByName tool to get information about a popular streamer"

Alternative: Local Installation Method

If you prefer to run from a local clone:

{
  "mcpServers": {
    "streamersonglist": {
      "command": "node",
      "args": ["src/server.js"],
      "cwd": "/path/to/streamersonglist-mcp"
    }
  }
}

✨ Features

🎵 11 Available Tools

Core Queue Management

• getStreamerByName: Fetch detailed information about a specific streamer
• getQueue: View current song queues with pagination support
• getQueueStats: Get comprehensive stats about song queues including total songs, duration, and popular tracks
• manageSongRequest: Create, update, and delete song requests
• monitorQueue: Monitor queue changes with configurable polling intervals

Play History & Song Database

• getPlayHistory: Retrieve play history with filtering and pagination
• searchSongs: Search the song database with various filters
• getSongDetails: Get detailed information about specific songs
• manageSongAttributes: Add, update, or remove song attributes like tags and ratings

Overlay & Analytics

• getOverlayData: Fetch real-time overlay data for streaming software
• getStreamStats: Get comprehensive streaming statistics and analytics

🔧 Technical Features

• MCP Protocol Compliant: Works with Claude Desktop, OpenAI agents, and other MCP clients
• Type Safety: Built with comprehensive input validation
• Error Handling: Robust error handling and user-friendly error messages
• No Authentication Required: Simplified setup without auth complexity
  • Update: Since I've added the other API endpoints, those will require authentication. (I haven't a use for them so I leave it up to you to figure out.) Otherwise, expect 404 responses.

💻 Usage Examples

Basic Usage

Use getStreamerByName with streamerName "belleune"

Advanced Usage

Use manageSongRequest to create a new request:
- action: "create"
- streamerName: "belleune"
- songTitle: "Bohemian Rhapsody"
- artist: "Queen"
- requesterName: "ChatUser123"

📚 Documentation

Tool Documentation

getStreamerByName

Fetch detailed information about a specific streamer.

Parameters:

• streamerName (string, required): The name of the streamer

Example:

Use getStreamerByName with streamerName "belleune"

getQueue

View current song queues with pagination support.

Parameters:

• streamerName (string, required): The name of the streamer whose queue to fetch
• limit (number, optional): Maximum number of songs to return (default: 50)
• offset (number, optional): Number of songs to skip for pagination (default: 0)

Example:

Use getQueue with streamerName "belleune" and limit 10

getQueueStats

Get comprehensive stats about song queues.

Parameters:

• streamerName (string, required): The name of the streamer whose queue stats to fetch

Example:

Use getQueueStats with streamerName "belleune"

manageSongRequest

Create, update, and delete song requests.

Parameters:

• action (string, required): The action to perform ("create", "update", or "delete")
• streamerName (string, required): The name of the streamer
• requestId (string, optional): The ID of the request (required for update/delete)
• songTitle (string, optional): The title of the song (required for create/update)
• artist (string, optional): The artist name
• requesterName (string, optional): The name of the person making the request
• message (string, optional): Optional message with the request

Examples:

Use manageSongRequest to create a new request:
- action: "create"
- streamerName: "belleune"
- songTitle: "Bohemian Rhapsody"
- artist: "Queen"
- requesterName: "ChatUser123"

monitorQueue

Monitor queue changes with configurable polling intervals.

Parameters:

• streamerName (string, required): The name of the streamer whose queue to monitor
• interval (number, optional): Polling interval in seconds (default: 30)
• duration (number, optional): How long to monitor in seconds (default: 300)

Example:

Use monitorQueue with streamerName "belleune", interval 60, duration 600

getPlayHistory

Retrieve play history with filtering and pagination support.

Parameters:

• streamerName (string, required): The name of the streamer whose play history to fetch
• limit (number, optional): Maximum number of entries to return (default: 50)
• offset (number, optional): Number of entries to skip for pagination (default: 0)
• startDate (string, optional): Start date filter (ISO format)
• endDate (string, optional): End date filter (ISO format)

Example:

Use getPlayHistory with streamerName "belleune", limit 20, startDate "2024-01-01"

searchSongs

Search the song database with various filters.

Parameters:

• query (string, optional): Search query for song title or artist
• artist (string, optional): Filter by specific artist
• genre (string, optional): Filter by music genre
• limit (number, optional): Maximum number of results (default: 50)
• offset (number, optional): Number of results to skip (default: 0)

Example:

Use searchSongs with query "bohemian", artist "Queen", limit 10

getSongDetails

Get detailed information about specific songs.

Parameters:

• songId (string, required): The unique identifier of the song

Example:

Use getSongDetails with songId "song_12345"

getOverlayData

Fetch real-time overlay data for streaming software.

Parameters:

• streamerName (string, required): The name of the streamer
• overlayType (string, optional): Type of overlay data ("current", "queue", "stats")

Example:

Use getOverlayData with streamerName "belleune", overlayType "current"

getStreamStats

Get comprehensive streaming statistics and analytics.

Parameters:

• streamerName (string, required): The name of the streamer
• period (string, optional): Time period for stats ("day", "week", "month", "year")
• startDate (string, optional): Start date for custom period (ISO format)
• endDate (string, optional): End date for custom period (ISO format)

Example:

Use getStreamStats with streamerName "belleune", period "week"

manageSongAttributes

Add, update, or remove song attributes like tags and ratings.

Parameters:

• action (string, required): The action to perform ("add", "update", "remove")
• songId (string, required): The unique identifier of the song
• attributeType (string, required): Type of attribute ("tag", "rating", "note")
• value (string, optional): The attribute value (required for add/update)

Example:

Use manageSongAttributes with action "add", songId "song_12345", attributeType "tag", value "rock"

🔧 Technical Details

Project Structure

streamersonglist-mcp/
├── src/
│   └── server.js          # Main MCP server implementation
├── package.json           # Node.js dependencies and scripts
├── test-server.js         # Test script
└── README.md             # This file

Testing

Run the test script to verify the server works correctly:

npm test

This will:

• Start the MCP server
• Send a test request
• Verify the server responds with the correct tools

Manual Testing

You can also test the server manually:

npm start

The server will start and wait for MCP protocol messages on stdin. You can send a test message:

{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}

API Endpoints

The server interacts with these StreamerSongList API endpoints:

Core Queue Management

• GET /v1/streamers/{streamerName} - Get streamer information
• GET /v1/streamers/{streamerName}/queue - Get song queue
• GET /v1/streamers/{streamerName}/queue/stats - Get queue statistics
• POST /v1/streamers/{streamerName}/requests - Create song request
• PUT /v1/streamers/{streamerName}/requests/{requestId} - Update song request
• DELETE /v1/streamers/{streamerName}/requests/{requestId} - Delete song request

Play History & Song Database

• GET /v1/streamers/{streamerName}/history - Get play history
• GET /v1/songs/search - Search song database
• GET /v1/songs/{songId} - Get song details
• POST /v1/songs/{songId}/attributes - Add song attributes
• PUT /v1/songs/{songId}/attributes/{attributeId} - Update song attributes
• DELETE /v1/songs/{songId}/attributes/{attributeId} - Remove song attributes

Overlay & Analytics

• GET /v1/streamers/{streamerName}/overlay - Get overlay data
• GET /v1/streamers/{streamerName}/stats - Get stream statistics

📄 License

MIT License - see LICENSE file for details.

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

📈 Changelog

v1.1.0

• NEW: Added 6 additional StreamerSongList API endpoints
• NEW: Play history retrieval with filtering (getPlayHistory)
• NEW: Song database search functionality (searchSongs)
• NEW: Detailed song information access (getSongDetails)
• NEW: Real-time overlay data for streaming software (getOverlayData)
• NEW: Comprehensive streaming analytics (getStreamStats)
• NEW: Song attribute management system (manageSongAttributes)
• Enhanced API coverage from 5 to 11 total tools
• Improved documentation with categorized tool sections
• Extended API endpoint coverage for comprehensive StreamerSongList integration

v1.0.0

• Initial release
• Core 5 StreamerSongList tools implemented
• MCP protocol compliance
• Claude Desktop integration
• Comprehensive error handling

⚠️ Troubleshooting

Common Issues

1. Server not starting:
   • Ensure Node.js 18+ is installed
   • Run npm install to install dependencies
   • Check for error messages in the console
2. Claude Desktop not seeing the server:
   • Verify the config file path is correct
   • Ensure the cwd path points to your project directory
   • Restart Claude Desktop completely
   • Check for JSON syntax errors in the config file
3. API errors:
   • The StreamerSongList API endpoints are simulated for demonstration
   • In a real implementation, you would need valid API credentials
   • Check network connectivity if using real endpoints

Getting Help

• Issues: Report bugs or request features on GitHub
• MCP Documentation: https://modelcontextprotocol.io
• Claude Desktop: https://claude.ai/download