Onesignal

🚀 一個信號MCP服務器

本項目是一個用於管理和操作OneSignal API的工具。它能讓您發送推送通知、電子郵件和短信，還提供對設備、段落和模板的管理功能。

🚀 快速開始

需求

• Python 3.6或更高版本
• 必須安裝以下庫：python-dotenv 和 requests
• 必須擁有一個OneSignal賬號並獲取相應的API憑證

安裝

方案一：克隆倉庫

git clone https://github.com/your-repository-url.git
cd onesignal-mcp-server
pip install -r requirements.txt

方案二：作為Python包安裝（即將推出）

pip install onesignal-mcp-server

配置

創建一個.env文件，並添加以下內容：

ONESIGNAL_APP_ID=your_app_id_here
ONESIGNAL_API_KEY=your_api_key_here
# 可選：設置日誌級別，默認為INFO
LOG_LEVEL=DEBUG

獲取API憑證請參考OneSignal文檔。

運行服務器

python -m onesignal_mcp_server.runserver

✨ 主要特性

推送通知管理

• 發送單個或批量推送通知
• 支持設置定時發送
• 查看已發送消息的詳細信息

設備管理

• 列出所有註冊設備
• 獲取特定設備的詳細信息

段落管理

• 創建新的段落
• 刪除現有的段落
• 查看所有可用段落

模板管理

• 創建自定義通知或電子郵件模板
• 查看現有模板的詳細信息

多應用支持

該服務器支持同時管理多個OneSignal應用。您可以通過添加不同的應用配置來實現。

💻 使用示例

基礎用法

發送推送通知

from onesignal_mcp_server import NotificationSender

sender = NotificationSender()
response = sender.send_push_notification(
    title="Hello",
    body="World",
    user_ids=["user1", "user2"]
)
print(response.status_code)  # 輸出狀態碼

📚 詳細文檔

日誌記錄

服務器提供詳細的日誌記錄功能，日誌輸出格式如下：

YYYY-MM-DD HH:MM:SS - onesignal-mcp-server - LEVEL - Message

默認情況下，日誌輸出到控制檯。您可以通過修改logging.basicConfig調用調整日誌級別。

測試

項目包含全面的測試套件，使用Python內置的unittest框架，並通過模擬外部API調用來測試服務器行為。

運行測試

python -m unittest discover tests

測試範圍

• 應用配置管理
• API請求處理與身份驗證
• 錯誤處理與恢復
• 多應用支持
• 組織級操作

故障排除

常見問題

無可用應用配置

如果出現錯誤“無應用配置可用”，請確保：

1. 您的.env文件設置正確，或
2. 已使用add_app工具添加了應用配置

API密鑰錯誤

如遇身份驗證錯誤，請檢查：

1. 您的API密鑰是否正確
2. 您是否在使用正確的密鑰進行操作（REST API密鑰與組織級API密鑰）
3. 密鑰是否具有相應的權限

速率限制

OneSignal對API請求有限制。遇到速率限制時，請：

1. 減少請求頻率
2. 實現帶有指數回退的重試邏輯

獲取幫助

如遇未解決的問題，請參考OneSignal API文檔或在GitHub倉庫打開問題。

貢獻指南

歡迎為改進OneSignal MCP服務器做出貢獻！請查閱CONTRIBUTING.md以獲取詳細指南。

📄 許可證

本項目根據MIT許可證發佈，具體請參閱LICENSE文件。

致謝

感謝您對開源社區的支持與貢獻。