使用说明
项目简介
本项目 'sound-mcp' 实现了一个简单的 Model Context Protocol (MCP) 服务器,专注于提供声音通知功能。它作为一个工具服务器运行,可以被配置到支持 MCP 协议的 AI 客户端(如 Claude Desktop App)中,使得 AI 智能体可以通过调用预设的工具来播放声音,实现远程声音提醒等功能。
主要功能点
- 远程声音播放: 通过 AI 智能体远程触发播放预设的声音文件。
- 可定制声音: 支持自定义声音文件和默认声音配置。
- 工具集成: 以 MCP Tool 的形式提供声音播放和声音列表功能,易于集成到 AI 工作流中。
- 免安装运行: 可通过 'npx' 直接运行,无需本地安装,方便快捷。
- 命令行界面: 提供友好的命令行工具,方便本地测试和管理声音。
安装步骤
本项目无需传统意义上的安装,因为它主要通过 'npx' (Node Package Execute) 运行。您只需确保您的环境中安装了 Node.js 和 npm (通常 npm 会随 Node.js 一起安装)。
- 检查 Node.js 和 npm: 在终端或命令提示符中运行以下命令,确保 Node.js (v16+) 和 npm 已正确安装:
如果版本过低,请升级 Node.js 环境。node -v npm -v
服务器配置
要将 'sound-mcp' 服务器配置到 MCP 客户端(例如 Claude Desktop App),您需要提供服务器的启动命令和参数。以下是配置信息,请复制到您的 MCP 客户端配置中:
{ "server name": "Sound MCP Server", "command": "npx", "args": [ "sound-mcp", "server", "--port", "8080" ] }
参数注释:
- '"server name"': 给这个 MCP 服务器配置起一个易于识别的名称,例如 "Sound MCP Server"。这会在您的 MCP 客户端界面中显示。
- '"command": "npx"': 指定用于启动服务器的命令为 'npx'。'npx' 允许您直接运行 npm 包,而无需全局安装。
- '"args"': 一个字符串数组,包含了 'npx' 命令的参数。
- '"sound-mcp"': 要执行的 npm 包名称。
- '"server"': 指定 'sound-mcp' 要运行的子命令,这里是启动服务器模式。
- '"–port"': 指定服务器监听的端口。
- '"8080"': 服务器监听的端口号,默认为 8080。您可以根据需要修改端口号,但要确保与客户端配置一致。
配置说明: 这段 JSON 配置告诉 MCP 客户端,启动名为 "Sound MCP Server" 的服务器时,需要执行 'npx sound-mcp server --port 8080' 这个命令。客户端会使用这个命令来启动 'sound-mcp' 服务器并与之建立连接。
基本使用方法
配置完成后,在您的 MCP 客户端中,您应该能够看到 "Sound MCP Server" 这个服务器选项。AI 智能体可以通过以下方式调用 'sound-mcp' 服务器提供的工具:
-
播放声音 (play_sound): 让 AI 智能体调用 'play_sound' 工具,并指定声音名称、音量和重复次数等参数。例如,在 Claude 中,您可以指示 Claude 执行类似 "Play a success sound with volume 0.7" 的操作。Claude 会解析指令并调用 'play_sound' 工具,服务器会播放相应的声音。
-
列出可用声音 (list_sounds): 让 AI 智能体调用 'list_sounds' 工具,获取服务器上可用的声音列表。例如,您可以询问 Claude "What sounds are available?",Claude 可能会调用 'list_sounds' 工具并返回声音列表。
本地测试: 您也可以在本地使用命令行工具 'sound-mcp' 进行测试,例如:
- 列出可用声音: 'npx sound-mcp list'
- 播放指定声音: 'npx sound-mcp play --sound=warning'
- 启动服务器 (用于本地测试工具调用): 'npx sound-mcp server'
注意事项
- 确保您的系统允许音频播放,并且 Node.js 环境配置正确。
- 声音文件默认存储在 'public/sounds/' 目录下,您可以自定义添加声音文件。
- 服务器默认监听 8080 端口,如果端口被占用,请修改配置或使用其他端口启动服务器。
信息
分类
桌面与硬件