MCP Server Notifier

MCP サーバー通知

AI エージェントがタスクを完了したときに Webhook を送信する、MCP（Model Context Protocol）と連携した軽量な通知サービスです。

简体中文文档

作成者

最初に作成したのは [email protected] です。
現在は zudsniper がメンテナンスしています。

特長

• Webhook 通知：AI エージェントがタスクを完了したときに通知を受け取れます
• 複数の Webhook プロバイダー：Discord、Slack、Microsoft Teams、Feishu、Ntfy、カスタム Webhook に対応しています
• 画像サポート：Imgur 経由で通知に画像を含められます
• 複数プロジェクトのサポート：異なるプロジェクトの通知を効率的に管理できます
• 簡単な連携：Cursor などの AI ツールと簡単にセットアップできます
• カスタマイズ可能なメッセージ：タイトル、本文、リンクを含むパーソナライズされた通知を送信できます

インストール

オプション 1：npm を使用

npm install -g mcp-server-notifier

オプション 2：Docker を使用

docker pull zudsniper/mcp-server-notifier:latest

# Run with environment variables
docker run -e WEBHOOK_URL=https://your-webhook-url -e WEBHOOK_TYPE=discord zudsniper/mcp-server-notifier

オプション 3：ソースからインストール

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

連携

Cursor との連携

1. 「Cursor Settings」を開きます
2. サイドバーの MCP をクリックし、次に + Add new global MCP server をクリックします
3. mcp-server-notifier を追加します。

{
   "mcpServers": {
      "notifier": {
         "command": "npx",
         "args": [
            "-y",
            "mcp-server-notifier"
         ],
         "env": {
            "WEBHOOK_URL": "https://ntfy.sh/webhook-url-example",
            "WEBHOOK_TYPE": "ntfy"
         }
      }
   }
}

設定

デフォルトでは、通知機能はいくつかの Webhook タイプに対応しています。

• Discord
• Slack
• Microsoft Teams
• Feishu
• Ntfy
• 汎用 JSON

環境変数で Webhook タイプと URL を指定できます。

env WEBHOOK_URL="https://your-webhook-url" WEBHOOK_TYPE="discord" npx -y mcp-server-notifier

認証トークン

WEBHOOK_TOKEN は任意の環境変数です。設定すると、ntfy Webhook リクエストに限り、Authorization ヘッダーに Bearer トークンとして含まれます。WEBHOOK_TOKEN が設定されていない場合、Authorization ヘッダーは送信されません。

• Basic 認証には対応していません。
• このトークンは、他のすべての Webhook プロバイダー（Discord、Slack、Teams、Feishu、汎用 JSON）では無視されます。

例：

env WEBHOOK_URL="https://ntfy.sh/your-topic" WEBHOOK_TYPE="ntfy" WEBHOOK_TOKEN="your-secret-token" npx -y mcp-server-notifier

設定ファイル

より詳細な設定を行うには、webhook-config.json ファイルを作成できます。

{
  "webhook": {
    "type": "discord",
    "url": "https://discord.com/api/webhooks/your-webhook-url",
    "name": "My Notifier"
  },
  "imgur": {
    "clientId": "your-imgur-client-id"
  }
}

詳細と例については、設定ガイドを参照してください。

使い方

• タスクが完了したときに、カスタムメッセージで通知するよう AI エージェントに依頼します
• 設定を繰り返さずに済むよう、Cursor の設定で永続的なルールとして構成します

詳しい使い方については、使用ガイドを参照してください。

利用可能なツール

1. notify
   • 目的：設定済みの任意の Webhook にリッチ通知を送信します
   • 入力：
     • message - 通知のテキスト内容
     • title（任意）- 通知のタイトル
     • link（任意）- 通知に含める URL（ntfy ではクリック時のアクションとして使用）
     • imageUrl（任意）- 含める画像の URL（旧形式。image または attachments を使用してください）
     • image（任意）- Imgur にアップロードする画像のローカルファイルパス
     • priority（任意、ntfy のみ）- 通知の優先度（1～5）
     • attachments（任意、ntfy のみ）- 添付する URL の配列
     • template（任意、ntfy のみ）- 使用する定義済みテンプレート：status、question、progress、problem
     • templateData（任意、ntfy のみ）- 選択したテンプレートに設定するデータ
     • actions（任意、ntfy のみ）- アクションボタンの定義（view または http）の配列
   • 最適な用途：一般的な通知

注： テンプレート機能は現在開発中で、サポートは限定的です。テンプレートは ntfy.sh で最も適切に動作しますが、すべての Webhook プロバイダーで完全に実装されているとは限りません。今後の実装予定については、ROADMAP.md ファイルを参照してください。

NTFY テンプレート

Webhook プロバイダーとして ntfy.sh を使用する場合、次の定義済みテンプレートを使用できます。

1. ステータステンプレート（status）

   • 目的：システム、プロセス、またはタスクのステータス更新を送信します
   • データフィールド：
     • status - 現在のステータス（例：「online」、「completed」、「pending」）
     • details（任意）- ステータスに関する追加情報
     • timestamp（任意）- このステータスが記録された日時
     • component（任意）- このステータスが適用されるシステムコンポーネント

2. 質問テンプレート（question）

   • 目的：回答が必要な質問をします
   • データフィールド：
     • question - 質問の内容
     • context（任意）- 質問の背景情報
     • options（任意）- 回答の選択肢
     • deadline（任意）- 回答が必要な期限

3. 進捗テンプレート（progress）

   • 目的：長時間実行されるタスクの進捗を追跡します
   • データフィールド：
     • title - タスクまたはプロセスの名前
     • current - 現在の進捗値
     • total - 完了に必要な合計値
     • percentage（任意）- 明示的な割合の値（指定されていない場合は計算されます）
     • eta（任意）- 完了までの推定時間
     • details（任意）- 進捗に関する追加情報

4. 問題テンプレート（problem）

   • 目的：エラーや問題を報告します
   • データフィールド：
     • title - 問題の簡潔な説明
     • description（任意）- 問題の詳細情報
     • severity（任意）- 問題の深刻度（例：「critical」、「warning」）
     • source（任意）- 問題が発生した場所
     • timestamp（任意）- 問題が発生した日時
     • solution（任意）- 問題の修正方法の提案

テンプレートの使用例：

// Send a progress notification
{
  "template": "progress",
  "templateData": {
    "title": "Database Backup",
    "current": 75,
    "total": 100,
    "eta": "2 minutes remaining",
    "details": "Compressing backup files"
  },
  "priority": 3
}

Docker サポート

MCP Server Notifier は Docker イメージとして利用できます。

docker pull zudsniper/mcp-server-notifier:latest

環境変数を指定して実行します。

docker run -e WEBHOOK_URL=https://your-webhook-url -e WEBHOOK_TYPE=discord zudsniper/mcp-server-notifier

設定例

Webhook の設定例は examples ディレクトリにあります。

開発

開発環境のセットアップ

1. リポジトリをクローンします。

git clone https://github.com/zudsniper/mcp-server-notifier.git
cd mcp-server-notifier

2. 依存関係をインストールします。

npm install

3. プロジェクトをビルドします。

npm run build

変更のテスト

1. MCP サーバーを開発モードで実行します。

# Install the MCP Inspector if you haven't already
npm install -g @modelcontextprotocol/inspector

# Start the server with the Inspector
npx @modelcontextprotocol/inspector node build/index.js

2. Inspector がウェブインターフェースを提供します。ここでは次のことができます。
   • ツールにリクエストを送信する
   • リクエストとレスポンスのログを確認する
   • 実装上の問題をデバッグする

新しいバージョンのリリース

新しいバージョンをリリースするには、次の手順を実行します。

1. package.json のバージョンを更新します
2. 変更を release ブランチにプッシュします
3. GitHub Actions が自動的に次の処理を実行します。
   • テストを実行する
   • Docker イメージをビルドしてプッシュする
   • npm に公開する
   • GitHub Release を作成する

CI/CD に必要なリポジトリシークレット：

• DOCKERHUB_USERNAME - Docker Hub のユーザー名
• DOCKERHUB_TOKEN - Docker Hub のアクセストークン
• NPM_TOKEN - npm のアクセストークン

ライセンス

MIT License - 詳細は LICENSE ファイルを参照してください。

貢献

貢献を歓迎します！お気軽に Pull Request を送信してください。

この MCP は MCP Review の認定を受けています。
認定ページ：https://mcpreview.com/mcp-servers/tuberrabbit/mcp-server-notifier