📤 ntfy-me-mcp

ntfy サービス (パブリックまたはトークンサポート付きのセルフホスト) 経由で通知を送信するための、合理化されたモデルコンテキストプロトコル (MCP) サーバー 📲

概要

ntfy-me-mcpは、AIアシスタントにntfyサービス（パブリックまたはトークンサポート付きのセルフホスト）を介してデバイスにリアルタイム通知を送信する機能を提供します。AIがタスクを完了したとき、エラーが発生したとき、重要なマイルストーンに到達したときに通知を受け取ることができます。これらはすべて、常時監視なしで行えます。

サーバーには、ビューアクションを作成するための自動 URL 検出や、スマートなマークダウン形式の検出などのインテリジェントな機能が含まれており、AI アシスタントが追加の構成なしでリッチでインタラクティブな通知を簡単に作成できるようになります。

入手可能:

名前	リンク / バッジ
グラマ.ai
スミザリー.ai

特徴
- 近日公開...
クイックスタート - MCP サーバーの構成
- NPM / NPX（推奨方法）
  - 最小限の構成
  - フル構成
    - オプション1: 直接トークン
    - オプション2: VS Code入力
- ドッカー
  - DockerでMCPを使用する
インストール
構成
- 環境変数
使用法
ライセンス
貢献

特徴

🚀クイックセットアップ：npx または docker で実行します。
🔔リアルタイム通知：タスクが完了すると、携帯電話/デスクトップで更新情報を受け取ることができます
🎨豊富な通知：トピック、タイトル、優先度、絵文字タグ、詳細メッセージのサポート
🔍通知の取得: ntfyトピックからキャッシュされたメッセージを取得してフィルタリングします
🎯スマートアクションリンク: メッセージ内のURLを自動的に検出し、表示アクションを作成します
📄インテリジェントマークダウン: マークダウン形式がある場合は自動検出して有効にします
🔒安全: アクセストークンによるオプションの認証
🔑入力マスキング: ntfy トークンを vs 構成に安全に保存します。
🌐セルフホストサポート：ntfy.shとセルフホストntfyインスタンスの両方で動作します

（近日公開...）

📨メール: メールで通知を送信します (ntfy メールサーバーの設定が必要です)
🔗クリック URL : クリック URL をカスタマイズする機能
🖼️画像 URL : インテリジェントな画像 URL 検出により、メッセージや通知に画像 URL を自動的に含めます
🏁そしてさらに！

クイックスタート - MCP サーバーの構成

NPM / NPX（推奨方法）

システムに npm / npx がインストールされている必要があります。
この方法は、サーバーをセットアップするためのシンプルで軽量な方法を提供するため、ほとんどのユーザーに推奨されます。

MCP 互換アシスタントを使用した最も簡単なセットアップでは、以下を MCP 構成に追加します。

最小限の構成（ntfy.sh の公開トピック用）

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-topic-name"
    }
  }
}

完全な構成（プライベートサーバーまたは保護されたトピックの場合）

オプション1: 構成内の直接トークン

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-topic-name",
      "NTFY_URL": "https://your-ntfy-server.com",
      "NTFY_TOKEN": "your-auth-token" // Use if using a protected topic/server
    }
  }
}

オプション 2: 安全なトークン処理のために VS Code 入力を使用する (推奨)

VS Code のsettings.json ファイルに以下を追加します。

"mcp": {
  "inputs": [
    { // Add this to your inputs array
      "type": "promptString",
      "id": "ntfy_token",
      "description": "Ntfy Token",
      "password": true
    }
  ],
  "servers": {
    // Other servers...
    "ntfy-me-mcp": {
      "command": "npx",
      "args": ["ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-topic-name",
        "NTFY_URL": "https://your-ntfy-server.com",
        "NTFY_TOKEN": "${input:ntfy_token}", // Use the input id variable for the token
        "PROTECTED_TOPIC": "true" // Prompts for token and masks it in your config
      }
    }
  }
}

この設定により、VS Code はサーバーの起動時にトークンの入力を要求し、入力時にトークンはマスクされます。

ドッカー

DockerでMCPを使用する

システムに Docker がインストールされている必要があります。
この方法は、コンテナ化された環境でサーバーを実行する場合に便利です。
Docker Hub または GitHub Container Registry で利用可能な公式 Docker イメージを使用できます。

Docker イメージ:

gitmotion/ntfy-me-mcp:latest (Docker ハブ)
ghcr.io/gitmotion/ntfy-me-mcp:latest (GitHub コンテナレジストリ)

MCP 構成 (例: VS Code の settings.json):

"mcp": {
  "servers": {
    "ntfy-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "NTFY_TOPIC",
        "-e",
        "NTFY_URL",
        "-e",
        "NTFY_TOKEN",
        "-e",
        "PROTECTED_TOPIC",         
        "gitmotion/ntfy-me-mcp", // OR use ghcr.io/gitmotion/ntfy-me-mcp:latest
      ],
      "env": {
        "NTFY_TOPIC": "your-topic-name",
        "NTFY_URL": "https://your-ntfy-server.com",
        "NTFY_TOKEN": "${input:ntfy_token}",
        "PROTECTED_TOPIC": "true"
      }
    }
  }
}

インストール

サーバーを直接インストールして実行する必要がある場合 (上記の MCP 構成の代替):

オプション1: グローバルにインストールする

npm install -g ntfy-me-mcp

オプション2: npxで実行

npx ntfy-me-mcp

オプション3: ローカルにインストールする

# Clone the repository
git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp

# Install dependencies
npm install

# Copy the example environment file and configure it
cp .env.example .env
# Edit .env with your preferred editor and update the variables
# nano .env  # or use your preferred editor

# Build the project
npm run build

# Start the server
npm start

オプション4: nodeコマンドでローカルにビルドして使用する

サーバーを開発またはカスタマイズしている場合は、node を使用して直接実行することをお勧めします。

# Clone the repository
git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp

# Install dependencies
npm install

# Copy the example environment file and configure it
cp .env.example .env
# Edit the .env file to set your NTFY_TOPIC and other optional settings
# nano .env  # or use your preferred editor

# Build the project
npm run build

# Run using node directly
npm start

MCPでローカルに構築されたサーバーを使用する

ローカルでビルドされたバージョンを使用するように MCP を構成する場合は、ビルドされた index.js ファイルへのノードコマンドとパスを指定します。

{
  "ntfy-me": {
    "command": "node",
    "args": ["/path/to/ntfy-mcp/build/index.js"],
    "env": {
      "NTFY_TOPIC": "your-topic-name",
      //"NTFY_URL": "https://your-ntfy-server.com", // Use if using a self-hosted server
      //"NTFY_TOKEN": "your-auth-token" // Use if using a protected topic/server
    }
  }
}

args 配列では、build/index.js ファイルへの絶対パスを使用することを忘れないでください。

オプション5: MCPマーケットプレイスのインストール

Smithery経由でインストール

Smithery経由で Claude Desktop 用の ntfy-me-mcp を自動的にインストールするには:

npx -y @smithery/cli install @gitmotion/ntfy-me-mcp --client claude

構成

環境変数

提供されている例をコピーして、プロジェクトディレクトリに.envファイルを作成します。

# Copy the example file
cp .env.example .env

# Edit the file with your preferred editor
nano .env  # or vim, code, etc.

.envファイルには次の変数が含まれている必要があります。

# Required
NTFY_TOPIC=your-topic-name

# Optional - Configure these if using a private/protected ntfy server
# NTFY_URL=https://ntfy.sh  # Default is ntfy.sh, change to your self-hosted ntfy server URL if needed
                            # Include port if needed, e.g., https://your-ntfy-server.com:8443
# NTFY_TOKEN=your-access-token  # Required for authentication with protected topics/servers
# PROTECTED_TOPIC=false  # Set to "true" if your topic requires authentication (helps prevent auth errors)

注： PROTECTED_TOPICフラグは、アプリケーションがトピックに認証が必要かどうかを判断するのに役立ちます。「true」に設定され、トークンが提供されていない場合は、トークンの入力を求められます。これにより、保護されたトピックでの認証エラーを防止できます。

使用法

認証

このサーバーは、認証された ntfy エンドポイントと認証されていない ntfy エンドポイントの両方をサポートします。

パブリックトピック: ntfy.sh またはその他のパブリックサーバーでパブリックトピックを使用する場合、認証は必要ありません。
保護されたトピック: 保護されたトピックまたはプライベートサーバーの場合は、アクセストークンを提供する必要があります。

認証が必要なのに提供されていない場合は、トークンを追加する方法を説明する明確なエラーメッセージが表示されます。

通知受信者の設定

デバイスにntfyアプリをインストールする
選択したトピックを購読する（ NTFY_TOPIC設定と同じ）

通知の送信（ntfy_me ツール）

このセクションでは、ntfy_me ツールを使用して通知を送信することに関連するすべての機能について説明します。

自然言語の使用

AI アシスタントを操作するときは、次のような自然なフレーズを使用できます。

"Send me a notification when the build is complete"
"Notify me when the task is done"
"Alert me after generating the code"
"Message me when the process finishes"
"Send an alert with high priority"

メッセージパラメータ

このツールは次のパラメータを受け入れます:

パラメータ	説明	必須
タスクタイトル	通知タイトル	はい
タスクサマリー	通知本文	はい
優先度	メッセージの優先度: 最小、低、デフォルト、高、最大	いいえ
タグ	通知タグの配列（絵文字ショートコードをサポート）	いいえ
マークダウン	マークダウンフォーマットを有効にするブール値（true/false）	いいえ
アクション	クリック可能なリンクのビューアクションオブジェクトの配列	いいえ

例：

{
  taskTitle: "Code Generation Complete",
  taskSummary: "Your React component has been created successfully with proper TypeScript typing.",
  priority: "high",
  tags: ["check", "code", "react"]
}

これにより、チェックマークの絵文字が付いた優先度の高い通知が送信されます。

アクションリンク

actionsパラメータを使用して通知にクリック可能なアクションボタンを追加したり、サーバーがメッセージ内の URL を自動的に検出できるようにしたりすることができます。

自動URL検出

メッセージ本文にURLが含まれている場合、サーバーは最初に検出されたURLから最大3つの表示アクション（ntfyの上限）を自動的に作成します。これにより、アクション配列を手動で指定することなく、クリック可能なリンクを簡単に含めることができます。

たとえば、次のメッセージ:

{
  taskTitle: "Build Complete",
  taskSummary: "Your PR has been merged! View the changes at https://github.com/org/repo/pull/123 or check the deployment at https://staging.app.com"
}

両方の URL の表示アクションが自動的に生成され、通知内で簡単にクリックできるようになります。

手動アクションの設定

さらに細かく制御するには、手動でアクションを指定できます。

財産	説明	必須
アクション	「表示」である必要があります	はい
ラベル	表示するボタンテキスト	はい
URL	クリックすると開くURL	はい
クリア	クリック時に通知をクリアするかどうか（オプション）	いいえ

アクションリンクの例:

{
  taskTitle: "Pull Request Review",
  taskSummary: "Your code has been reviewed and is ready for final checks",
  priority: "high",
  tags: ["check", "code"],
  actions: [
    {
      action: "view",
      label: "View PR",
      url: "https://github.com/org/repo/pull/123"
    },
    {
      action: "view",
      label: "View Changes",
      url: "https://github.com/org/repo/pull/123/files",
      clear: true
    }
  ]
}

絵文字ショートコード

視覚的なインジケーターとして、タグ内で絵文字ショートコードを使用できます。

warning → ⚠️
check →✅
rocket → 🚀
tada → 🎉

サポートされている絵文字ショートコードの完全なリストを参照してください。

Markdownフォーマット

通知は、インテリジェントなtaskSummary機能を備えた豊富なマークダウン形式をサポートします。taskSummary にマークダウン構文を含めると、サーバーはそれを自動的に検出し、マークダウン解析を有効にします。明示的にmarkdown: trueを設定する必要はありません。

自動検出

サーバーは次のような一般的なマークダウンパターンをチェックします。

ヘッダー (#、## など)
リスト（-、*、数字）
コードブロック (```)
リンク（テキスト）
太字/斜体（テキスト、テキスト）

これらのパターンが検出されると、メッセージのマークダウン解析が自動的に有効になります。

手動オーバーライド

自動検出はほとんどの場合に機能しますが、マークダウン解析を明示的に制御することもできます。

{
  taskTitle: "Task Complete",
  taskSummary: "Regular plain text message",
  markdown: false  // Force disable markdown parsing
}

メッセージの取得（ntfy_me_fetch ツール）

このセクションでは、ntfy_me_fetch ツールを使用してメッセージを取得およびフィルタリングすることに関連するすべての機能について説明します。

自然言語の使用

AI アシスタントは、メッセージの取得を要求するさまざまな方法を理解します。

"Show me my recent notifications"
"Get messages from the last hour"
"Find notifications with title 'Build Complete'"
"Search for messages with the test_tube tag"
"Show notifications from the updates topic from the last 24hr"
"Check my latest alerts"

メッセージパラメータ

このツールは次のパラメータを受け入れます:

パラメータ	説明	必須
ntfyトピック	メッセージの取得元トピック（デフォルトは NTFY_TOPIC 環境変数）	いいえ
以来	どのくらいさかのぼってメッセージを取得するか（「10 分」、「1 時間」、「1 日」、タイムスタンプ、メッセージ ID、または「すべて」）	いいえ
メッセージID	IDで特定のメッセージを検索する	いいえ
メッセージテキスト	正確なテキスト内容を含むメッセージを検索する	いいえ
メッセージタイトル	正確なタイトル/件名を持つメッセージを検索する	いいえ
優先事項	特定の優先度のメッセージを検索する	いいえ
タグ	特定のタグが付いたメッセージを検索する	いいえ

例

最近のメッセージを取得

{
  since: "30m"  // Get messages from last 30 minutes
}

タイトルと優先度でフィルタリング

{
  messageTitle: "Build Complete",
  priorities: "high",
  since: "1d"
}

タグで異なるトピックを検索

{
  ntfyTopic: "updates",
  tags: ["error", "warning"],
  since: "all"
}

特定のメッセージを検索

{
  messageId: "xxxxXXXXxxxx"
}

メッセージは、以下の詳細情報とともに返されます:

メッセージIDとタイムスタンプ
トピックとタイトル
内容と優先順位
タグと添付ファイル
アクションリンクと有効期限

注：メッセージ履歴の可用性は、ntfyサーバーのキャッシュ設定によって異なります。パブリックntfy.shサーバーは通常、メッセージを12時間キャッシュします。

発達

ソースから構築

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

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。

Gitmotionによって ❤️ で作成されました

Integrations

📤 ntfy-me-mcp

概要

入手可能:

目次

特徴

（近日公開...）

クイックスタート - MCP サーバーの構成

NPM / NPX（推奨方法）

最小限の構成（ntfy.sh の公開トピック用）

完全な構成（プライベートサーバーまたは保護されたトピックの場合）

オプション1: 構成内の直接トークン

オプション 2: 安全なトークン処理のために VS Code 入力を使用する (推奨)

ドッカー

DockerでMCPを使用する

インストール

オプション1: グローバルにインストールする

オプション2: npxで実行

オプション3: ローカルにインストールする

オプション4: nodeコマンドでローカルにビルドして使用する

MCPでローカルに構築されたサーバーを使用する

オプション5: MCPマーケットプレイスのインストール

Smithery経由でインストール

構成

環境変数

使用法

認証

通知受信者の設定

通知の送信（ntfy_me ツール）

自然言語の使用

メッセージパラメータ

アクションリンク

自動URL検出

手動アクションの設定

絵文字ショートコード

Markdownフォーマット

自動検出

手動オーバーライド

メッセージの取得（ntfy_me_fetch ツール）

自然言語の使用

メッセージパラメータ

例

発達

ソースから構築

ライセンス

貢献