REAPER

🚀 REAPER MCP Server

The REAPER MCP Server is a comprehensive Model Context Protocol (MCP) server that enables AI agents to create complete mixing and mastering tracks in REAPER. It supports MIDI and audio functions, allowing users to efficiently manage and control music projects.

🚀 Quick Start

Launch the Server

• Using Terminal or Command Prompt:

# On macOS/Linux
cd [Project Directory]
source venv/bin/activate
python -m src.reaper_mcp.server

• Using the Provided Startup Script:

./scripts/start_reaper_mcp_server.sh

Access Documentation

After the server is launched, you can access the API documentation by opening http://localhost:5000 in your browser.

✨ Features

• Complete Project Management: Includes project creation, saving, and rendering.
• Track Creation: Add new tracks to the current project.
• Track Listing: List all tracks in the current project.
• MIDI Symbol Addition: Add MIDI symbols to the selected track.
• Project Information Retrieval: Get detailed information about the current project.

📦 Installation

Installation Requirements

1. REAPER DAW: Ensure that the REAPER Digital Audio Workstation is installed.
2. Python 3.8 or Higher: A Python environment is required to run the server.
3. OSC Support: Make sure OSC (Open Sound Control) communication is enabled in REAPER.
4. ReaScript API Support: Confirm that the ReaScript scripting interface is enabled in REAPER.

Installation Steps

1. Clone the repository using Git:

git clone [Repository URL]

2. Create and activate a virtual environment (Python 3.8+ recommended):

python -m venv venv
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate     # On Windows

3. Install dependencies:

pip install -r requirements.txt

4. Start the server:

python -m src.reaper_mcp.server

💻 Usage Examples

Basic Usage

• Launch the Server:

# On macOS/Linux
cd [Project Directory]
source venv/bin/activate
python -m src.reaper_mcp.server

• Access API Documentation: Open http://localhost:5000 in your browser.

Advanced Usage

• Use the Provided Startup Script:

./scripts/start_reaper_mcp_server.sh

• Configure Server Mode:

./scripts/start_reaper_mcp_server.sh --mode=reascript

📚 Documentation

Configuration Options

• Default Mode: OSC mode.
• ReaScript Mode:

./scripts/start_reaper_mcp_server.sh --mode=reascript

REAPER Settings

OSC Mode Configuration

1. Open the “Options” menu in REAPER and select “Preferences”.
2. Find the “Network” section in the left menu.
3. Enable OSC support and set the port to 5000.
4. Ensure the “Enabled” option is checked.

ReaScript Mode Configuration

python src/reaper_mcp/scripts/setup_reaper_python.py

Project Structure

• src/reaper_mcp/: Main package directory
  • __main__.py: Command-line interface.
  • osc_server.py: OSC-based server implementation.
  • server.py: ReaScript-based server implementation.
• examples/: Example scripts for usage.
• scripts/: Utility startup and running scripts.

MCP Tools

• create_project: Create a new REAPER project.
• create_track: Add a new track to the current project.
• list_tracks: List all tracks in the current project.
• add_midi_note: Add MIDI symbols to the selected track.
• get_project_info: Get information about the current project.

🔧 Technical Details

Troubleshooting

ReaScript API Issues

If you encounter issues with the ReaScript API, it is recommended to use OSC mode:

./scripts/start_reaper_mcp_server.sh --mode=osc

OSC Communication Issues

• Ensure that the OSC settings in REAPER match the server configuration.
• Check if the firewall is blocking the relevant ports.
• Try using the local IP address (127.0.0.1) for communication.

Windows-Specific Issues

• Script Execution Issues:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

• Port Conflicts: Ensure that the target port (default 5000) is not occupied by other programs.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.

Contact

If you have feedback or questions, please contact [Maintainer's Email] or visit [Project Homepage].

Thank you for using the REAPER MCP Server!