Ntfy Push Notifications

🚀 NTFY机器人处理消息项目配置指南

本项目主要用于配置和使用NTFY机器人处理消息，提供了安装、配置、使用等方面的详细指南，帮助用户快速搭建和使用相关工具。

🚀 快速开始

本项目提供了便捷的方式来配置和使用NTFY机器人处理消息，下面将详细介绍安装、配置和使用的步骤。

📦 安装指南

使用npm安装

node install https://github.com/gitmotion/ntfy-me-mcp.git

通过Git克隆仓库安装

git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp
npm install

⚙️ 配置指南

设置环境变量

必要配置

设置 NTFY_TOPIC 环境变量以指定默认的NTFY主题：

export NTFY_TOPIC=your-topic-name

可选配置

根据需要设置以下任意环境变量：

• NTFY_URL：指定NTFY服务地址，默认为 https://ntfy.sh。
• NTFY_AUTH：配置NTFFY认证信息（如API密钥）。

💻 使用示例

发送消息工具 (ntfy_me)

命令行使用

ntfy_me --title "通知标题" --message "通知内容" [--priority 等级] [--tags 标签列表]

基础用法

发送一条默认消息：

ntfy_me --title "新邮件到达" --message "您有一封新的电子邮件，请查收。"

高级用法

设置高优先级和标签：

ntfy_me --title "服务器警告" --message "CPU 使用率过高，建议检查。" --priority high --tags warning,alert

检索消息工具 (ntfy_me_fetch)

命令行使用

ntfy_me_fetch [--topic 主题名称] [--since 时间范围] [--message-id 消息ID]

基础用法

获取最近30分钟的消息：

ntfy_me_fetch --since 30m

高级用法

根据标题和优先级筛选消息：

ntfy_me_fetch --topic updates --messageTitle "更新完成" --priorities high

🛠️ 开发指南

从源代码构建

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

📄 许可证

本项目遵循 GNU General Public License v3.0 协议，具体内容请参阅 LICENSE 文件。

🤝 贡献指南

欢迎贡献！请随意提交 Pull Request。

由 gitmotion 开发，❤️ 献给开源社区。