Telegram MCP客户端

一个基于NestJS构建的Telegram客户端,用于Model Context Protocol (MCP)操作,具备基础命令管理、模块化结构和错误处理功能。

  • by Bigchef-dev
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 Bigchef-dev/telegram-mcp-client

使用说明

Telegram MCP 客户端

一个使用NestJS构建的Telegram客户端,用于Model Context Protocol(MCP)操作。

先决条件

  • Node.js(版本18或更高)
  • pnpm
  • 一个Telegram机器人(通过@BotFather获取的令牌)

安装

  1. 克隆仓库:
git clone <repository-url>
cd telegram-mcp-client
  1. 安装依赖项:
pnpm install
  1. 配置环境变量:
cp .env.example .env
  1. 编辑文件 .env 并添加您的Telegram机器人令牌:
TELEGRAM_BOT_TOKEN=your_telegram_bot_token_here

使用

发展

pnpm start:dev

生产

pnpm build
pnpm start:prod

测试

pnpm test
pnpm test:watch
pnpm test:cov

功能特性

  • 集成Telegram机器人
  • 📱 基本命令管理(/start,/help,/status,/ping)
  • 🔧 使用 NestJS 的模块化结构
  • 记录完成
  • 🛡️ 坚固的错误处理
  • 🔄 优雅停车

机器人指令

  • /start - 启动机器人
  • /help 显示帮助
  • /status - 检查机器人的状态
  • /ping - 连接测试

项目结构

src/
├── app.module.ts       # Module principal de l'application
├── app.service.ts      # Service principal
├── main.ts            # Point d'entrée de l'application
└── telegram/          # Module Telegram
    ├── telegram.module.ts
    └── telegram.service.ts

配置

该机器人使用以下环境变量:

  • TELEGRAM_BOT_TOKEN - Telegram机器人的令牌(必需)
  • NODE_ENV - 运行环境
  • LOG_LEVEL - 日志级别

未来发展

  • MCP(模型上下文协议)集成
  • MCP 操作高级命令
  • [ ] 对话式用户界面
  • 用户会话管理
  • 用于持久化的数据库

许可证

麻省理工