MCP Communicator (Telegram)

MCP Communicator (Telegram)

site icon
2025.01.24 26
JavaScriptTelegram 通信文件共享用户交互交流协作
MCP Communicator (Telegram) 是一个通过 Telegram 与用户进行通信的 MCP 服务器。它提供了多种工具,包括向用户提问、发送通知、分享文件以及创建项目归档等功能。
View on GitHub

Overview

基本能力

产品定位

MCP Communicator (Telegram) 是一个基于 Telegram 的通信工具,旨在通过 Telegram 机器人实现与用户的高效交互。

核心功能

  • 通过 Telegram 向用户提问并等待响应
  • 向用户发送通知(无需响应)
  • 通过 Telegram 向用户发送文件
  • 创建并发送项目 zip 文件(遵循 .gitignore 规则)
  • 支持异步响应(无限期等待响应)
  • 支持基于回复的消息跟踪
  • 安全的聊天 ID 验证
  • 错误处理和日志记录

适用场景

  • 需要与用户进行远程交互的场景
  • 需要向用户发送通知或文件的场景
  • 需要收集用户反馈的场景
  • 需要共享项目文件的场景

工具列表

  1. ask_user: 通过 Telegram 向用户提问并等待响应。
  2. notify_user: 向用户发送通知消息(无需响应)。
  3. send_file: 向用户发送文件。
  4. zip_project: 创建项目目录的 zip 文件并发送给用户(遵循 .gitignore 规则)。

常见问题解答

  • 如何获取 Telegram 聊天 ID? 使用内置工具 npx mcptelegram-chatid 获取。
  • 如何配置 Telegram 机器人? 通过 @BotFather 创建机器人并获取 token。
  • 如何处理大文件? 支持最大 2GB 的文件传输。

使用教程

使用依赖

  • Node.js (v14 或更高版本)
  • Telegram 机器人 token(从 @BotFather 获取)
  • Telegram 聊天 ID(使用内置工具获取)

安装教程

  1. 通过 npm 全局安装: bash npm install -g mcp-communicator-telegram
  2. 或通过 npx 按需运行: bash npx mcptelegram
  3. 获取聊天 ID: bash npx mcptelegram-chatid

调试方式

  1. 克隆仓库: bash git clone https://github.com/qpd-v/mcp-communicator-telegram.git cd mcp-communicator-telegram
  2. 安装依赖: bash npm install
  3. 运行开发模式: bash npm run dev
  4. 监视更改: bash npm run watch

许可证

该项目遵循 ISC 开源许可条款。