MCP Communicator Telegram

🚀 MCP 通信器（Telegram）

MCP 通信器（Telegram）是一個 MCP 服務器，藉助 Telegram 實現與用戶的通信。它提供了豐富的工具，可通過 Telegram 機器人與用戶進行互動，涵蓋提問、發送通知、共享文件以及創建項目存檔等功能。

🚀 快速開始

若要使用 MCP 通信器（Telegram），需完成以下幾個關鍵步驟：

1. 安裝必要的依賴和工具。
2. 配置服務器信息。
3. 運用提供的工具與用戶進行交互。

✨ 主要特性

• 提問功能：可通過 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/specific/directory'
  }
});

🔧 技術細節

先決條件

• Node.js (v14 或更高版本)
• Telegram 機器人令牌（從@BotFather獲得）
• 你的 Telegram 聊天 ID（使用隨附工具獲取）