Onesignal

🚀 オーンシグナルMCPサーバー

本プロジェクトは、OneSignal APIを管理および操作するためのツールです。 プッシュ通知、電子メール、およびSMSを送信でき、デバイス、パラグラフ、およびテンプレートの管理機能も提供します。

🚀 クイックスタート

このセクションでは、オーンシグナルMCPサーバーの基本的な使い方を説明します。以下の手順に従って、サーバーをセットアップし、動作を確認しましょう。

✨ 主な機能

プッシュ通知管理

• 単一またはバッチでのプッシュ通知の送信
• スケジュール送信のサポート
• 送信済みメッセージの詳細情報の閲覧

デバイス管理

• すべての登録デバイスの一覧表示
• 特定のデバイスの詳細情報の取得

パラグラフ管理

• 新しいパラグラフの作成
• 既存のパラグラフの削除
• 利用可能なすべてのパラグラフの閲覧

テンプレート管理

• カスタム通知または電子メールテンプレートの作成
• 既存のテンプレートの詳細情報の閲覧

📦 インストール

方法1：リポジトリをクローンする

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

方法2：Pythonパッケージとしてインストール（近日公開予定）

pip install onesignal-mcp-server

💻 使用例

基本的な使用法

サーバーの起動

python -m onesignal_mcp_server.runserver

プッシュ通知の送信

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)  # ステータスコードを出力

高度な使用法

このサーバーは、複数のOneSignalアプリを同時に管理することができます。異なるアプリ設定を追加することで、この機能を利用できます。

📚 ドキュメント

ログ記録

サーバーは詳細なログ記録機能を提供し、ログ出力形式は以下の通りです。

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 ファイルを参照してください。

謝辞

オープンソースコミュニティへのサポートと貢献に感謝します。