Sonos

🚀 Sonos MCP Server

This project is a Sonos MCP (Model Context Protocol) server that allows you to control and interact with Sonos devices on the network. It offers various features such as discovering devices, controlling playback status, retrieving device status, and managing queues.

✨ Features

• Discover Sonos devices on the network.
• Retrieve and control the playback status of devices.
• Manage the playback queue.
• Expose functionality as MCP tools.

📋 Requirements

• Python 3.7+
• uv for managing Python projects.

📦 Installation

1. Clone the repository:

   git clone https://github.com/WinstonFassett/sonos-mcp-server.git
   cd sonos-mcp-server
   

2. Install the required dependencies using uv:

   uv sync
   

💻 Usage Examples

Running the Server

Standard Input Output (Stdio)

Run the server using stdio:

uv run mcp run server.py

Using SSE with Supergateway

Run the server using SSE via the supergateway tool:

npx -y supergateway --port 8000 --stdio "uv run mcp run server.py"

Alternatively, you can use the convenient script stored in the repository:

./npx-serve-sse-8000.sh

Development

Run the server in "development" mode with an MCP inspector:

uv run mcp dev server.py

This command hosts an MCP inspector for testing and debugging purposes. To run the server in SSE development mode, use the SSE command with supergateway and run in a second terminal window:

npx @modelcontextprotocol/inspector

Available MCP Tools

Use the exposed MCP tools to interact with Sonos devices. Available tools include:

• get_all_device_states: Retrieve status information for all discovered Sonos devices.
• now_playing: Retrieve information about the currently playing content on all Sonos devices.
• get_device_state: Retrieve status information for a specific Sonos device.
• pause, stop, play: Control the playback status of Sonos devices.
• next, previous: Skip tracks on Sonos devices.
• get_queue, get_queue_length: Manage the playback queue of Sonos devices.
• mode: Get or set the playback mode of Sonos devices.
• partymode: Enable party mode on the current Sonos device.
• speaker_info: Retrieve speaker information for Sonos devices.
• get_current_track_info: Retrieve information about the currently playing track.
• volume: Get or set the volume of Sonos devices.
• skip, play_index, remove_index_from_queue: Manage the position of tracks in the queue.

📄 License

This project is licensed under the MIT License. For more details, see the LICENSE file.