Ntfy Me MCP

🚀 ntfy-me-mcp 📤

ntfy-me-mcp は、自前でホストしている ntfy サーバーに通知を送信するための効率的なサーバーです。このプロジェクトはトークンベースの安全な認証をサポートしており、npx または Docker で実行できます。

最新バージョンをダウンロード

🚀 クイックスタート

ntfy-me-mcp を使えば、Model Context Protocol (MCP) を通じて、自前でホストしている ntfy サーバーへの通知送信が簡単に行えます。個人開発者でもチームメンバーでも、このツールは通知を管理する信頼性の高い方法を提供します。

✨ 主な機能

• 安全なトークン認証: トークンを使って通知を保護します
• 使いやすい: ほとんど設定を必要とせず、すぐに使い始めることができます
• Docker 対応: コンテナ化された環境でサーバーを実行できます
• クロスプラットフォーム対応: Linux と Windows システムに対応しています
• 軽量: リソースの使用を抑えつつ、性能を維持するように設計されています

📦 インストール

ntfy-me-mcp を使い始めるには、以下の手順に従ってください。

前提条件

インストールする前に、以下がインストールされていることを確認してください。

• Node.js（npx を使用する場合）
• Docker（コンテナ化して使用する場合）
• 自前でホストしている ntfy サーバーへのアクセス権

npx を使用する場合

1. ターミナルを開きます。
2. 以下のコマンドを実行します。

npx ntfy-me-mcp

このコマンドで最新バージョンを取得し、直接実行できます。

Docker を使用する場合

1. Docker イメージを取得します。

docker pull dieg0ski/ntfy-me-mcp

2. Docker コンテナを実行します。

docker run -d dieg0ski/ntfy-me-mcp

設定

インストールが完了したら、設定ファイルでサーバーのパラメータを設定してください。トークン認証のために適切な環境変数を設定することを確認してください。

💻 使用例

基本的な使用法

インストールが完了したら、ntfy サーバーに通知を送信できます。

npx ntfy-me-mcp send "あなたの通知メッセージ"

高度な使用法

安全なトークン認証でトークンを使用するには、環境変数を通じて渡します。

TOKEN=あなたの安全トークン npx ntfy-me-mcp send "あなたの通知メッセージ"

Docker を使用する場合、環境変数を通じてトークンをコンテナに渡すことができます。

docker run -e TOKEN=あなたの安全トークン dieg0ski/ntfy-me-mcp send "あなたの通知メッセージ"

🤝 貢献

私たちは、ntfy-me-mcp への貢献を歓迎します！何か提案や改善点がある場合は、以下の手順に従ってください。

1. ローカルリポジトリをフォークします。
2. 新しい機能や修正のためのブランチを作成します。
3. 変更をコミットします。
4. ブランチをあなたのフォークリポジトリにプッシュします。
5. プルリクエストを作成します。 コードが私たちのコーディング標準に沿っていることを確認し、適用可能な場合はテストを含めてください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細については、LICENSE ファイルを参照してください。

📞 連絡先

何か質問やフィードバックがある場合は、GitHub のイシューを通じて、または直接プロジェクトのメンテナに連絡してください。

最新バージョンをダウンロード リリースノート で詳細を確認できます。