使用说明

项目简介

MCP Telegram Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它将 Telegram 的功能以工具 (Tools) 的形式暴露给大型语言模型 (LLM) 客户端。通过此服务器，LLM 可以调用 Telegram 的各种能力，例如发送消息、查询信息等，从而实现更丰富的 Telegram 自动化应用场景。

主要功能点

Telegram 功能集成: 将 Telegram 的常用操作封装为 MCP 工具，例如发送消息、获取联系人等（具体工具取决于仓库的完整实现，当前代码片段中未明确展示具体 Telegram 工具）。
MCP 服务器框架: 基于 'mcp.server.fastmcp' 构建，提供标准的 MCP 协议支持，可以与任何兼容 MCP 协议的 LLM 客户端进行交互。
工具管理: 支持 MCP 的工具注册和管理机制，允许 LLM 客户端发现和调用 Telegram 工具。
用户认证: 通过 Telegram 官方 API 进行用户身份验证，确保安全访问 Telegram 功能。
命令行界面 (CLI): 提供友好的命令行界面，用于版本查询、用户登录、服务器启动和工具列表查看等管理操作。

安装步骤

安装 Python 环境: 确保您的系统已安装 Python 3.8 或更高版本。

克隆仓库: 将 'mcp-telegram' 仓库克隆到本地：

git clone https://github.com/dryeab/mcp-telegram.git
cd mcp-telegram

安装依赖: 使用 pip 安装项目依赖：
```
pip install .
```

服务器配置

MCP Telegram Server 需要配置在 MCP 客户端中，以便客户端能够连接并使用其提供的 Telegram 工具。以下是 MCP 客户端所需的服务器配置信息（JSON 格式）：

{
  "server_name": "mcp-telegram",
  "command": "mcp-telegram",
  "args": ["start"],
  "transport": "stdio",
  "capabilities": ["tools"]
}

配置参数说明:

'server_name': 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器。例如: '"mcp-telegram"'。
'command': 启动 MCP Telegram Server 的命令。这里是项目安装后提供的命令行工具名称 '"mcp-telegram"'。
'args': 传递给启动命令的参数。'["start"]' 表示运行 'mcp-telegram start' 命令来启动服务器。
'transport': MCP 客户端与服务器通信的传输协议。 '"stdio"' 表示使用标准输入输出进行通信，这是一种常用的本地进程间通信方式。
'capabilities': 声明服务器提供的能力。'["tools"]' 表示该服务器提供工具 (Tools) 功能。如果未来该服务器扩展了资源 (Resources) 或 Prompt 模板 (Prompts) 功能，可以在此列表中添加 '"resources"' 或 '"prompts"'。

重要提示: 请将以上 JSON 配置信息填写到您的 MCP 客户端的服务器配置中。具体的配置位置和方法请参考您使用的 MCP 客户端的文档。

基本使用方法

登录 Telegram: 首次使用前，需要使用命令行工具登录您的 Telegram 账号。在终端中运行：
```
mcp-telegram login
```
根据提示输入您的 Telegram API ID, API Hash 和手机号码，并完成 Telegram 官方的验证流程。API ID 和 API Hash 需要在 Telegram 开发者平台 (https://my.telegram.org/apps) 创建应用后获取。
启动 MCP Telegram Server: 登录成功后，在终端中运行以下命令启动 MCP Telegram Server：
```
mcp-telegram start
```
服务器启动后，会监听来自 MCP 客户端的请求。保持该终端窗口运行，直到您停止使用 MCP Telegram Server。
在 MCP 客户端中使用 Telegram 工具: 在 MCP 客户端中配置并连接到 MCP Telegram Server 后，您应该可以在客户端中发现和使用由 MCP Telegram Server 提供的 Telegram 工具。具体工具的名称、参数和使用方法，请参考 MCP 客户端的工具列表或相关文档（当前代码片段中未明确展示具体 Telegram 工具，需查看仓库的完整代码以确定具体工具功能）。
查看可用工具列表 (可选): 您可以使用以下命令查看 MCP Telegram Server 当前提供的工具列表：
```
mcp-telegram tools
```
此命令会以表格形式在终端中显示工具的名称、描述和参数信息。

注意:

本使用说明基于提供的代码片段分析，实际功能可能与完整仓库代码有所差异。
请务必妥善保管您的 Telegram API ID, API Hash 和手机号码等敏感信息。
使用 Telegram API 需遵守 Telegram 官方的使用条款和限制。

关键词