ntfy-mcp: Your Friendly Task Completion Notifier

ntfy-mcp: Your Friendly Task Completion Notifier

site icon
2025.03.25 15
JavaScript通知服务任务管理交流协作
ntfy-mcp 是一个基于 Model Context Protocol (MCP) 的通知服务,用于在 AI 助手完成任务时通过 ntfy 发送通知。它旨在帮助用户在任务完成时及时获得通知,而无需持续监控任务状态。
View on GitHub

Overview

基本能力

产品定位

ntfy-mcp 是一个通知服务,专门用于在 AI 助手完成任务时发送通知,帮助用户提高工作效率。

核心功能

  1. 任务完成通知:当 AI 助手完成任务时,通过 ntfy 发送通知。
  2. 无缝集成:与 Model Context Protocol (MCP) 无缝集成,确保通知的及时性和准确性。
  3. 自定义主题:用户可以选择自己的 ntfy 主题来接收通知。
  4. 自动批准:支持自动批准通知请求,确保用户体验流畅。

适用场景

  1. 开发任务:在编写代码或执行脚本时,任务完成后接收通知。
  2. 自动化流程:在自动化流程中,任务完成时通知用户。
  3. 团队协作:团队成员完成任务时,通知其他成员。

工具列表

  1. ntfy 应用:用于接收通知的移动应用。
  2. Model Context Protocol SDK:用于与 MCP 集成的 SDK。
  3. node-fetch:用于 HTTP 请求的库。
  4. dotenv:用于环境变量管理的库。
  5. zod:用于数据验证的库。

常见问题解答

  1. 如何设置 ntfy 主题?:在配置文件中设置 NTFY_TOPIC 环境变量。
  2. 如何启动服务?:使用 npm start 命令启动服务。
  3. 如何确保通知被发送?:在任务描述中包含“notify me when the task is done”关键字。

使用教程

使用依赖

安装前置依赖:

npm install

安装教程

  1. 克隆仓库:
git clone https://github.com/teddyzxcv/ntfy-mcp.git
cd ntfy-mcp
  1. 安装依赖:
npm install
  1. 构建项目:
npm run build
  1. 启动服务:
npm start

调试方式

  1. 确保服务已启动:
npm start
  1. 检查日志:查看控制台输出,确保服务正常运行。
  2. 测试通知:发送包含“notify me when the task is done”的任务,检查是否收到通知。

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。