使用说明
项目简介
Telegram AI Connector 是一个Telegram Bot,它充当用户与大型语言模型 (LLM) 之间的桥梁。该项目基于 Model Context Protocol (MCP) 的理念,旨在为LLM提供上下文信息和工具,使其在Telegram环境中能够执行更复杂的任务。用户可以通过Telegram消息与AI助手对话,并利用其提供的各种工具。
主要功能点
- Telegram 消息交互: 监听Telegram消息,通过AI助手进行回复。
- OpenAI 集成: 目前支持 OpenAI 的 LLM 模型。
- 工具扩展: 提供多种工具,例如:
- 提醒功能: 设置定时提醒消息。
- 文件操作: 接收用户上传的文件,并提供文件存储路径。
- 系统信息查询: 获取服务器的运行状态和系统信息。
- 消息发送: 通过工具控制AI助手发送消息。
- 简单的会话管理: 通过内存聊天记录保持简单的会话上下文。
- 登录认证: 提供简单的密码登录机制,保护Bot的使用。
安装步骤
-
创建 Telegram Bot:
- 访问 BotFather 并按照指示创建一个新的 Bot。
- 复制 BotFather 提供的 Bot Token。
-
获取 OpenAI API Key:
- 访问 OpenAI Platform 并创建一个账号。
- 获取 API Key。
-
配置应用程序:
- 下载最新的 Release 中的 'telegramAIConnector-0.0.1-SNAPSHOT.jar' 文件。
- 下载并修改 application.yaml 配置文件:
- 'telegram.key': 设置为 Telegram Bot Token。
- 'telegram.password': 设置登录密码 (用于 '/login' 命令)。
- 'openai.api-key': 设置 OpenAI API Key。
- 'telegramIAConnector.uploadFolder': 设置文件上传的本地存储目录。
- (可选) 下载并修改 mcp-servers-config.json 文件,尽管该文件在此项目中可能没有直接使用,但可以参考其结构理解配置方式。
-
运行应用程序:
- 确保已安装 Java 21 或更高版本。
- 使用以下命令运行 JAR 文件,并指定配置文件路径:
将 '/path/to/application.yaml' 替换为 'application.yaml' 文件的实际路径。java -jar telegramAIConnector-0.0.1-SNAPSHOT.jar --spring.config.location=file:/path/to/application.yaml
服务器配置 (MCP客户端配置)
对于 MCP 客户端,需要配置连接到此 Telegram AI Connector 服务器的信息。由于 Telegram AI Connector 不是一个标准的基于 JSON-RPC 的 MCP 服务器,它通过 Telegram Bot 消息进行交互,因此 不需要配置标准的 MCP 服务器连接信息。
客户端(Telegram 用户)通过 Telegram Bot 应用与此“服务器”交互,无需直接配置服务器的 command 和 args。 用户只需要在 Telegram 中找到并启动 Bot,然后使用 '/login' 命令进行登录即可开始使用。
如果需要将此服务集成到更广泛的 MCP 客户端框架中,可能需要开发一个适配器,将 Telegram Bot 的消息交互转换为 MCP 客户端可以理解的请求和响应格式。 但就目前仓库提供的功能来看,它更像是一个独立的、基于 MCP 理念的 Telegram AI 应用,而非一个可以被通用 MCP 客户端直接连接的服务器。
基本使用方法
- 启动 Bot 后,在 Telegram 中找到你的 Bot。
- 发送 '/login YOURPASSWORD' 命令进行登录,其中 'YOURPASSWORD' 替换为你设置的密码。
- 登录成功后,即可与 Bot 进行对话。
- 可以使用自然语言与 Bot 交互,Bot 会尝试理解你的意图并调用相应的工具进行回复。
- 可以使用 Bot 提供的工具,例如设置提醒 (使用自然语言告知 Bot 设置提醒的时间和内容)。
- 可以上传文件给 Bot,Bot 会保存文件到配置的 'uploadFolder' 目录。
请注意,由于这是一个基于 Telegram Bot 的应用,其交互方式和标准 MCP 服务器有所不同。
信息
分类
生产力应用