Sound Notification

🚀 Sound Notification MCP (JPN Prior to ENG)

This project is an MCP server designed to play prompt sounds when AI coding assistants like Windsurf or Cursor need the user's attention. It can play prompt sounds when code writing is completed or user approval is required.

🚧 Important Note & Disclaimer

⚠️ Important Note

• ※ When adding settings, make sure to add relevant entries to the rules as well.
• Currently, only MacOS is supported (as the creator uses a Mac and cannot verify the Windows environment).
• Since MCP calls are determined by the LLM, sounds may be triggered at unexpected times or unexpected behaviors may occur.
• For Cursor, the prompt sound may not play before command execution.
• When using Windsurf, the prompt sound may play multiple times (please pay attention to battery consumption).

📦 Installation

Prerequisites

• Node.js (version v18 or higher)
• Yarn package manager

Installation Steps

# Clone the repository
git clone <repository-url>
cd sound-notification-mcp

# Install dependencies
yarn install

# Build the project
yarn build

The installation is now complete.

Configuration in Windsurf or Cursor

Cursor

An example configuration is provided in the /.cursor/mcp.json file. (Writing the configuration to /.cursor/mcp.json means these settings will be applied automatically each time you start.)

Windsurf

Ensure the following content is added to your global rules file global_rules.md and memory library:

### Sound Notification MCP Settings
- Use sound notifications when prompts are needed.
- Prompt sound path: `/System/Library/Sounds/Glass.aiff`

This ensures that the AI assistant always uses sound notifications when necessary.

⚙️ Customization Options

Changing the Prompt Sound

Modify the following part of the code:

const SYSTEM_SOUND_PATH = '/System/Library/Sounds/Glass.aiff'; // MacOS default prompt sound

Available sound files on MacOS (located in the /System/Library/Sounds/ directory) include:

• Bottle.aiff
• Frog.aiff
• Funk.aiff
• Glass.aiff
• Hero.aiff
• Morse.aiff
• Ping.aiff
• Pop.aiff
• Purr.aiff
• Sosumi.aiff
• Submarine.aiff
• Tink.aiff

🛠️ Troubleshooting

If No Sound is Playing

1. Check if the system volume is set correctly.
2. Confirm that the specified sound file exists.
3. Check the terminal output for error messages.

If the MCP Server Fails to Start

1. Ensure that Node.js and Yarn are installed correctly.
2. Check if the dependencies are installed successfully:

   yarn install
   

3. Check for build errors:

   yarn build
   

📄 License

This project is licensed under the MIT License.