使用说明

✨ 通知MCP服务器✨

梦想它，像素它。用❤️ Pink Pixel。

概述

一个模型上下文协议服务器，允许AI代理在任务完成时播放通知声音。这个基于TypeScript的MCP服务器提供了一个简单、可配置的通知系统 开箱即用的捆绑声音 npx！

✨ 特性

🔧 工具

notify -任务完成时显示桌面吐司通知和/或播放声音（建议用于摘要）
- message （必填）：已完成任务的通知消息/摘要
- title （可选）：吐司通知的标题（默认为“任务已完成”）
- mode （可选）： "toast" | "sound" | "both" （默认为 "both")
- sound （可选）：要播放的声音的名称，它会覆盖默认设置
- 完全支持Windows、macOS和Linux开箱即用！
play_notification -播放通知声音以指示任务完成
- 取一个可选项 message 用于记录/显示通知的参数
- 支持跨平台声音播放（Windows、macOS和Linux）
- 适用于捆绑声音 -无需手动下载！

🎵 内置声音库

5个高质量的通知声音与软件包捆绑在一起：

cosmic -太空主题通知🌌
fairy -魔幻、异想天开的基调🧚‍♀️
gentle -柔和、悦耳的默认声音（默认）🔔
pleasant -平衡、专业的语气📞
retro -怀旧复古风格通知🕹️
random -随机播放5种声音中的一种🎲

🚀 快速开始

选项1：使用捆绑音效（推荐）⭐

只需使用npx运行它-包括声音！

{
  "mcpServers": {
    "notifications": {
      "command": "npx",
      "args": ["-y", "@pinkpixel/notification-mcp"]
    }
  }
}

选项2：选择不同的捆绑声音

{
  "mcpServers": {
    "notifications": {
      "command": "npx",
      "args": ["-y", "@pinkpixel/notification-mcp"],
      "env": {
        "MCP_NOTIFICATION_SOUND": "cosmic"
      }
    }
  }
}

选项3：每次随机声音🎲

{
  "mcpServers": {
    "notifications": {
      "command": "npx",
      "args": ["-y", "@pinkpixel/notification-mcp"],
      "env": {
        "MCP_NOTIFICATION_SOUND": "random"
      }
    }
  }
}

选项4：使用自己的自定义声音

{
  "mcpServers": {
    "notifications": {
      "command": "npx",
      "args": ["-y", "@pinkpixel/notification-mcp"],
      "env": {
        "MCP_NOTIFICATION_SOUND_PATH": "C:\\path\\to\\your\\sound.mp3"
      }
    }
  }
}

⚙️ 配置

可以使用环境变量配置通知声音：

环境变量

变量	描述	默认值
`MCP_NOTIFICATION_SOUND`	从捆绑的声音中选择： `cosmic`, `fairy`, `gentle`, `pleasant`, `retro`, `random`	`gentle`
`MCP_NOTIFICATION_SOUND_PATH`	指向您自己的MP3文件的绝对路径（覆盖捆绑的声音）	`null`

优先顺序

自定义路径 (MCP_NOTIFICATION_SOUND_PATH)-最高优先级
捆绑音效 (MCP_NOTIFICATION_SOUND)-从包含的5种声音中选择
默认 -如果没有指定，则发出柔和的蜂鸣声

💻 用法

配置后，您的MCP客户端可以调用统一 notify 工具或仅音频 play_notification 工具：

1.统一吐司+声音通知（推荐）

await client.request({
  method: "tools/call",
  params: {
    name: "notify",
    arguments: {
      title: "Build Succeeded",
      message: "Antigravity successfully tested the package version 0.2.0! 🚀",
      mode: "both", // "toast", "sound", or "both"
      sound: "cosmic" // optional override
    }
  }
});

2.仅音频通知

await client.request({
  method: "tools/call",
  params: {
    name: "play_notification",
    arguments: {
      message: "Task completed successfully! 🎉"
    }
  }
});

🛠️ 发展

地方发展设置

# Clone the repository
git clone https://github.com/pinkpixel-dev/notification-mcp.git
cd notification-mcp

# Install dependencies
npm install

# Build the server
npm run build

# For development with auto-rebuild
npm run watch

本地开发配置

{
  "mcpServers": {
    "notifications": {
      "command": "node",
      "args": ["./build/index.js"],
      "env": {
        "MCP_NOTIFICATION_SOUND": "retro"
      }
    }
  }
}

调试

使用 MCP检查员对于交互式调试：

npm run inspector

Inspector提供了一个web界面，用于在浏览器中测试您的MCP服务器。

📦 安装方法

NPX（推荐）

无需安装-声音会自动捆绑：

npx @pinkpixel/notification-mcp

全局安装

npm install -g @pinkpixel/notification-mcp
notification-mcp

本地安装

npm install @pinkpixel/notification-mcp
npx notification-mcp

🎵 声音文件

所有声音文件都位于 sounds/ 目录，并在安装软件包时自动包含：

宇宙： sounds/cosmic_chime.mp3 - 🌌 太空主题
仙女： sounds/fairy_chime.mp3 - 🧚‍♀️ 神奇的
温和： sounds/gentle_chime.mp3 - 🔔 默认值（软）
愉快：sounds/pleasant_chime.mp3 - 📞 专业的
复古的： sounds/retro_chime.mp3 - 🕹️ 复古
随机：设置 MCP_NOTIFICATION_SOUND=random - 🎲 让我吃惊！

🤝 贡献

我们欢迎捐款！请参阅贡献.md 作为指导方针。

📄 许可证

该项目在MIT和Apache 2.0许可证下获得双重许可-请参阅许可证文件以获取详细信息。

🌟 关于粉红像素

网站： pinkpixel.dev
github： github/pinkpixel-dev
不一致： @嘶嘶声

制作于❤️ 由粉红色像素 ✨