OneSignal MCP Server

OneSignal MCP Server

site icon
2025.04.08 1
Python推送通知管理多应用支持交流协作
OneSignal MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于与 OneSignal API 进行交互。该服务提供了一个便捷的接口,用于管理推送通知、电子邮件、短信、用户设备、分段、模板等,通过 OneSignal 的 REST API 实现。
View on GitHub

Overview

基本能力

产品定位

OneSignal MCP Server 是一个用于管理 OneSignal 通知服务的中间件,提供了一套工具来简化与 OneSignal API 的交互。

核心功能

  • 发送推送通知、电子邮件和短信
  • 管理用户设备和订阅
  • 创建和管理分段
  • 创建和管理模板
  • 查看应用信息和分析
  • 组织级操作
  • 管理多个 OneSignal 应用

适用场景

  • 需要向用户发送推送通知的应用
  • 需要管理多个 OneSignal 应用的项目
  • 需要自动化处理通知和用户分段的团队

工具列表

  • 消息管理send_notification, view_messages, view_message_details, cancel_message
  • 设备管理view_devices, view_device_details
  • 分段管理view_segments, create_segment, delete_segment
  • 模板管理view_templates, view_template_details, create_template
  • 应用信息view_app_details

常见问题解答

  • 无应用配置可用:确保 .env 文件已正确设置或使用 add_app 工具添加应用配置。
  • API 密钥错误:验证 API 密钥是否正确,并确保具有必要的权限。
  • 速率限制:减少请求频率或实现指数退避重试逻辑。

使用教程

使用依赖

  • Python 3.7 或更高版本
  • python-dotenv
  • requests
  • OneSignal 账户和 API 凭证

安装教程

选项 1:从 GitHub 克隆

git clone https://github.com/weirdbrains/onesignal-mcp.git
cd onesignal-mcp
pip install -r requirements.txt

选项 2:作为包安装(即将推出)

pip install onesignal-mcp

配置

  1. 在根目录创建 .env 文件,包含 OneSignal 凭证:
ONESIGNAL_APP_ID=your_app_id_here
ONESIGNAL_API_KEY=your_rest_api_key_here
ONESIGNAL_ORG_API_KEY=your_organization_api_key_here
  1. 从 OneSignal 仪表板获取凭证。

调试方式

运行服务器

python onesignal_server.py

测试

python -m unittest discover tests

许可证

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