Ntfy MCP Server

Ntfy MCP Server

site icon
2025.04.04 0
TypeScript推送通知服务LLM集成交流协作
Ntfy MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,专门用于与 ntfy 推送通知服务交互。它使 LLMs 和 AI 代理能够向用户设备发送高度可定制的通知。该服务器提供了丰富的通知功能,包括消息优先级设置、表情标签、可点击操作和按钮、文件附件、延迟交付以及 Markdown 格式化等。
View on GitHub

Overview

基本能力

产品定位

Ntfy MCP Server 是一个中间件服务,连接 LLM 代理和 ntfy 推送通知服务,实现标准化的通知功能。

核心功能

  • MCP 服务器实现:使用 @modelcontextprotocol/sdk 实现,与 LLM 代理无缝集成
  • Ntfy 集成:提供 send_ntfy 工具发送通知,支持:
  • 消息优先级设置(1-5级)
  • 表情标签
  • 可点击操作和按钮
  • 文件附件
  • 延迟交付
  • Markdown 格式化
  • 资源暴露:将配置的默认 ntfy 主题作为 MCP 资源公开
  • TypeScript:现代、类型安全的代码库
  • 结构化日志:使用 winstonwinston-daily-rotate-file
  • 配置管理:使用 dotenv 进行环境配置
  • 实用脚本:包括清理构建工件和生成目录结构文档的脚本
  • 错误处理与安全:实现健壮的错误处理、输入消毒和安全过滤器

适用场景

  1. 长时间运行任务通知
  2. 计划提醒
  3. 警报系统
  4. 从 LLM 发送移动通知
  5. 多步骤流程更新

工具列表

  • send_ntfy:通过 ntfy 服务发送通知消息,支持多种参数配置

常见问题

  • 需要配置 ntfy 主题
  • 需要安装 ntfy 应用并订阅主题
  • 需要正确设置环境变量

使用教程

使用依赖

  • Node.js (v16+)
  • npm 或 yarn
  • MCP 兼容客户端(Claude Desktop, Cline 等)

安装教程

选项1: NPM 包(推荐)

npm install -g ntfy-mcp-server

选项2: 从源代码安装

git clone https://github.com/cyanheads/ntfy-mcp-server.git
cd ntfy-mcp-server
npm install
npm run build

调试方式

  1. 创建 .env 文件(基于 .env.example)
  2. 启动服务器:
npm start
  1. 添加到 MCP 客户端设置
  2. 使用 send_ntfy 工具发送测试通知

许可证

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