article
README
🚀 声音通知 MCP (JPN 优先于 ENG)
本项目搭建了一个MCP服务器,当AI编码助手(如Windsurf或Cursor)需要用户关注时,该服务器会播放提示音。无论是代码编写完成,还是需要用户批准,都能通过声音及时提醒用户。
🚀 快速开始
本项目是一个MCP服务器,用于在AI编码助手如Windsurf或Cursor需要用户注意时播放提示声音。当代码编写完成或需要用户批准时,即可通过该服务器播放提示声音。
⚠️ 注意事项&免责声明
⚠️ 重要提示
- 添加设置时,请务必同时将相关条目添加到规则中。
- 当前仅支持 MacOS(由于创建者使用Mac且无法验证Windows环境)。
- 由于MCP调用由LLM判断决定,可能会在意外时间触发声音或出现非预期行为。
- 对于Cursor,在命令执行前有时不会播放提示音。
- 使用Windsurf时,可能会出现提示音多次播放的现象(请留意电量消耗)。
📦 安装指南
前提条件
- Node.js (v18以上版本)
- Yarn包管理器
安装步骤
# 克隆仓库
git clone <repository-url>
cd sound-notification-mcp
# 安装依赖项
yarn install
# 构建项目
yarn build
至此,安装完成。
在Windsurf或Cursor中的配置
Cursor
在/.cursor/mcp.json文件中提供了示例配置。
(将配置写入/.cursor/mcp.json意味着每次启动时会自动应用这些设置。)
Windsurf
确保将以下内容添加到你的全局规则文件global_rules.md和记忆库中:
### 声音通知 MCP 设置
- 在需要提示时使用声音通知。
- 提示声音路径:`/System/Library/Sounds/Glass.aiff`
这将确保AI助手在必要时始终使用声音通知。
💻 使用示例
基础用法
若需更改提示声音,可修改以下部分的代码:
const SYSTEM_SOUND_PATH = '/System/Library/Sounds/Glass.aiff'; // MacOS默认提示音
MacOS可用的声音文件包括(位于/System/Library/Sounds/目录):
- Bottle.aiff
- Frog.aiff
- Funk.aiff
- Glass.aiff
- Hero.aiff
- Morse.aiff
- Ping.aiff
- Pop.aiff
- Purr.aiff
- Sosumi.aiff
- Submarine.aiff
- Tink.aiff
🔧 故障排除
如果没有声音播放
- 检查系统音量是否已正确设置。
- 确认指定的声音文件存在。
- 查看终端输出以获取错误信息。
如果MCP服务器启动失败
- 确保Node.js和Yarn已正确安装。
- 检查依赖项是否安装成功:
yarn install - 检查是否有构建错误:
yarn build
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫