使用说明

项目简介

这是一个基于 Model Context Protocol (MCP) 的服务器，专注于提供通知声音播放功能。它允许连接的 AI 代理在完成任务或需要提示时，通过标准化的 MCP 协议触发播放本地声音，从而提供听觉反馈。

主要功能

• 播放通知声音: 通过调用 MCP 工具，AI 代理可以请求服务器播放特定的声音。
• 内置音效库: 包含了多种精心挑选的通知音效，开箱即用。
• 支持自定义音效: 用户可以指定自己的 MP3 文件作为通知声音。
• 跨平台支持: 支持在 Windows 和 macOS 操作系统上播放声音。

安装

推荐使用 'npx' 命令直接运行此服务器，无需额外安装：

npx @pinkpixel/notification-mcp

这会自动下载并执行服务器代码，包括内置的音效文件。

服务器配置

此 MCP 服务器通常作为子进程由 MCP 客户端启动和管理。你需要在你的 MCP 客户端的配置文件（通常是 JSON 格式）中进行如下配置，以告知客户端如何启动并连接到此服务器：

以下是一个 MCP 客户端配置片段的示例，说明了如何配置启动这个通知服务器：

{
  // ... 其他客户端配置
  "mcpServers": {
    "notifications": { // 为这个服务器指定一个唯一的名称，例如 "notifications"
      "command": "npx", // 指定启动服务器的命令
      "args": ["-y", "@pinkpixel/notification-mcp"], // 指定命令的参数。"-y" 参数允许 npx 跳过确认提示。
      "env": { // 可选：通过环境变量配置服务器行为
        // "MCP_NOTIFICATION_SOUND": "cosmic" // 设置为内置音效名称 (cosmic, fairy, gentle, pleasant, retro, random)。如果未设置，默认为 "gentle"。
        // "MCP_NOTIFICATION_SOUND_PATH": "/path/to/your/custom/sound.mp3" // 设置为自定义MP3文件的绝对路径，这将覆盖内置音效设置。
      }
    }
  }
  // ... 其他客户端配置
}

• 'command': 启动服务器进程的可执行文件路径。
• 'args': 传递给 'command' 的命令行参数列表。
• 'env': 一个对象，用于设置启动服务器进程时所需的环境变量。你可以通过 'MCP_NOTIFICATION_SOUND' 或 'MCP_NOTIFICATION_SOUND_PATH' 环境变量来配置要播放的通知声音。

基本使用方法

一旦 MCP 客户端成功启动并连接到 Notification MCP 服务器，AI 代理就可以通过调用服务器提供的工具来播放通知声音。该服务器提供了一个名为 'play_notification' 的工具。

AI 代理可以通过发送一个 MCP 请求来调用此工具，例如（这是一个概念性的请求示例，具体的调用方式取决于你的 MCP 客户端 SDK）：

// 假设 client 是你的 MCP 客户端实例
await client.request({
  method: "tools/call", // 调用工具的标准 MCP 方法
  params: {
    name: "play_notification", // 要调用的工具名称
    arguments: { // 传递给工具的参数
      message: "任务已成功完成！" // 可选参数：可以附带一条文本消息
    }
  }
});

当 MCP 客户端收到此请求并转发给 Notification MCP 服务器时，服务器会根据配置播放相应的声音，并返回一个成功或失败的响应。