MCP Communicator Telegram

🚀 MCP 通信器（Telegram）

MCPサーバーで、Telegramを通じてユーザーと通信します。このサーバーは、Telegramボットを介してユーザーとやり取りするツールを提供しており、質問の送信、通知の配信、ファイルの共有、プロジェクトアーカイブの作成などが可能です。

🚀 クイックスタート

このMCP通信器を使用する前に、いくつかの前提条件を満たす必要があります。また、インストールと設定の手順を正しく行うことで、スムーズに利用できるようになります。

✨ 主な機能

• Telegramを通じてユーザーに質問を送信する
• ユーザーに通知を送信する（応答不要）
• Telegramを通じてユーザーにファイルを送信する
• プロジェクトのZIPファイルを作成して送信する（.gitignoreルールを尊重）
• ユーザーの応答を非同期で受け取る（応答を無制限に待機）
• 返信ベースのメッセージ追跡をサポート
• 安全なチャットID検証
• エラー処理とログ記録

📦 インストール

npmを使用したグローバルインストール

npm install -g mcp-communicator-telegram

npxを使用した按需インストール

npx mcptelegram

TelegramのチャットIDを取得するには、以下のコマンドを実行します。

npx mcptelegram-chatid

リポジトリをクローンしてインストール

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

git clone https://github.com/qpd-v/mcp-communicator-telegram.git
cd mcp-communicator-telegram

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

npm install

3. Telegramボットを作成し、トークンを取得します。

4. 以下のコマンドを使用して、あなたのTelegramチャットIDを取得します。

npx mcptelegram-chatid

🔧 設定

サーバーをMCP設定ファイルに追加します。

config/mcp.jsonに以下の内容を追加します。

{
  "telegram": {
    "botToken": "your_bot_token",
    "chatId": "your_chat_id"
  }
}

💻 使用例

利用可能なツール

ask_user

Telegramを通じて質問を送信します。

入力モード

{
  "type": "question",
  "question": "あなたの質問？",
  "messageId": "string" // 回答を関連付けるためのオプションのTelegramメッセージID
}

基本的な使用法

await useMCP({
  server: 'telegram',
  tool: 'ask_user',
  arguments: {
    question: 'あなたが好きな色は何ですか？',
    messageId: '12345'
  }
});

notify_user

Telegramを通じて通知を送信します。

入力モード

{
  "type": "notification",
  "message": "あなたのメッセージ。",
  "messageId": "string" // オプションのTelegramメッセージID
}

基本的な使用法

await useMCP({
  server: 'telegram',
  tool: 'notify_user',
  arguments: {
    message: 'システムの状態が更新されました。',
    messageId: '67890'
  }
});

send_file

Telegramを通じてファイルを送信します。

入力モード

{
  "type": "file",
  "filePath": "path/to/file", // オプションのファイルパス、デフォルトは現在のディレクトリ
  "message": "オプションのメッセージ内容"
}

基本的な使用法

• デフォルトディレクトリのファイルを送信する場合

await useMCP({
  server: 'telegram',
  tool: 'send_file',
  arguments: {}
});

• 特定のパスのファイルを送信する場合

await useMCP({
  server: 'telegram',
  tool: 'send_file',
  arguments: {
    filePath: '/path/to/your/file'
  }
});

zip_project

プロジェクトのZIPファイルを作成して送信します。

入力モード

{
  "type": "directory",
  "directory": "string" // オプションのディレクトリパス、デフォルトは現在の作業ディレクトリ
}

基本的な使用法

• デフォルトディレクトリ（現在の作業ディレクトリ）を使用する場合

await useMCP({
  server: 'telegram',
  tool: 'zip_project',
  arguments: {}
});

• 特定のディレクトリを指定する場合

await useMCP({
  server: 'telegram',
  tool: 'zip_project',
  arguments: {
    directory: '/path/to/your/directory'
  }
});

📚 ドキュメント

前提条件

• Node.js (v14 またはそれ以上のバージョン)
• Telegramボットトークン（@BotFatherから取得）
• あなたのTelegramチャットID（付属のツールを使用して取得）