返回市场
通知-mcp

通知-mcp

作者:pinkpixel-dev9 星标更新:2025-06-01

项目介绍

<div align="center"> <img src="https://gips0.baidu.com/it/u=1496903385,1474147881&fm=3081&app=3081&f=JPEG?w=512&h=512" alt="通知 MCP 标志" width="200" height="200"/>

✨ 通知 MCP 服务器 ✨

梦想它,像素化它。由 Pink Pixel 制作 ❤️。

许可证 模型上下文协议 npm 版本 smithery 徽章

TypeScript Node.js npm

NPM 下载量 GitHub 星标数 GitHub 问题 欢迎 PR

平台支持 用心打造 Pink Pixel

</div>

概述

这是一个允许AI代理在任务完成后播放通知声音的模型上下文协议服务器。这个基于TypeScript的MCP服务器提供了一个简单且可配置的通知系统,带有开箱即用的捆绑声音,通过npx即可使用!

✨ 功能

🔧 工具

  • play_notification - 播放一个通知声音以指示任务完成
    • 接受一个可选的message参数来显示与通知一起的消息
    • 支持跨平台的声音播放(Windows 和 macOS)
    • 使用捆绑声音 - 不需要手动下载!

🎵 内置声音库

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从捆绑声音中选择:cosmicfairygentlepleasantretrorandomgentle
MCP_NOTIFICATION_SOUND_PATH自己MP3文件的绝对路径(覆盖捆绑声音)null

优先级顺序

  1. 自定义路径 (MCP_NOTIFICATION_SOUND_PATH) - 最高优先级
  2. 捆绑声音 (MCP_NOTIFICATION_SOUND) - 从5个包含的声音中选择
  3. 默认 - 如果没有指定,默认为柔和的铃声

💻 使用方法

一旦配置好,您的MCP客户端可以调用play_notification工具:

await client.request({
  method: "tools/call",
  params: {
    name: "play_notification",
    arguments: {
      message: "任务成功完成!🎉"
    }
  }
});

🛠️ 开发

本地开发设置

# 克隆仓库
git clone https://github.com/pinkpixel-dev/notification-mcp.git
cd notification-mcp

# 安装依赖
npm install

# 构建服务器
npm run build

# 开发时自动重建
npm run watch

本地开发配置

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

调试

使用MCP Inspector进行交互式调试:

npm run inspector

Inspector 提供了一个网页界面,在浏览器中测试您的 MCP 服务器。

📦 安装方法

NPX(推荐)

无需安装 - 声音自动捆绑:

npx @pinkpixel/notification-mcp

全局安装

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

本地安装

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

🎵 声音文件

所有声音文件都位于sounds/目录下,并在安装包时自动包含:

  • Cosmic: sounds/cosmic_chime.mp3 - 🌌 太空主题
  • Fairy: sounds/fairy_chime.mp3 - 🧚‍♀️ 魔法般的
  • Gentle: sounds/gentle_chime.mp3 - 🔔 默认(柔和)
  • Pleasant: sounds/pleasant_chime.mp3 - 📞 专业的
  • Retro: sounds/retro_chime.mp3 - 🕹️ 怀旧的
  • Random: 设置 MCP_NOTIFICATION_SOUND=random - 🎲 让我惊喜!

🤝 贡献

我们欢迎贡献!请参阅CONTRIBUTING.md获取指南。

📄 许可证

此项目根据MIT许可证发布 - 详情见LICENSE文件。

🌟 关于 Pink Pixel


由 Pink Pixel 制作 ❤️