使用说明

项目简介:

'mcp-telegram' 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在连接 Telegram API 和 AI 助手，使 AI 助手能够访问您的 Telegram 数据。目前，该服务器提供对 Telegram API 的只读访问，允许 AI 助手获取 Telegram 对话列表和消息列表。

主要功能点:

• 获取 Telegram 对话列表（包括群组和频道）。
• 获取指定对话中的消息列表（包括未读消息）。
• 支持通过 MCP 协议与 AI 助手（如 Claude Desktop）进行通信。
• 允许用户扩展工具以增加更多 Telegram 相关功能。

安装步骤:

1. 确保已安装 'uv' 工具，如果没有请参考 uv installation 进行安装。
2. 使用 'uv tool install' 命令安装 'mcp-telegram' 服务器：

   uv tool install git+https://github.com/sparfenyuk/mcp-telegram
   

服务器配置:

为了让 MCP 客户端（如 Claude Desktop）连接到 'mcp-telegram' 服务器，您需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 的配置示例，您需要根据您的实际 API ID 和 API Hash 进行替换：

{
  "mcpServers": {
    "mcp-telegram": {
        "command": "mcp-server",
        "env": {
          "TELEGRAM_API_ID": "<your-api-id>",
          "TELEGRAM_API_HASH": "<your-api-hash>"
        }
      }
    }
  }

配置参数说明：

• 'server name': 'mcp-telegram' (服务器名称，在客户端配置中用于标识服务器)
• 'command': 'mcp-server' (启动服务器的命令，通常为 'mcp-server'，实际执行命令可能因客户端而异)
• 'env': 环境变量配置
  • 'TELEGRAM_API_ID': 您的 Telegram API ID (需要您在 Telegram 开发者平台创建应用后获取)
  • 'TELEGRAM_API_HASH': 您的 Telegram API Hash (同样在 Telegram 开发者平台创建应用后获取)

基本使用方法:

1. 获取 Telegram API 凭据: 访问 Telegram API 并登录，创建新的应用以获取 'API ID' 和 'API hash'。
2. 配置 Telegram API 凭据: 运行以下命令，并按照提示完成 Telegram 登录认证：

   mcp-telegram sign-in --api-id <your-api-id> --api-hash <your-api-hash> --phone-number <your-phone-number>
   

3. 配置 MCP 客户端: 将上述 "服务器配置" 中的 JSON 代码添加到您的 MCP 客户端（如 Claude Desktop）的配置文件中，并替换 '<your-api-id>' 和 '<your-api-hash>' 为您在步骤 1 中获取的凭据。
4. 在 MCP 客户端中使用: 启动 MCP 客户端，它应该能够连接到 'mcp-telegram' 服务器，并允许您通过 AI 助手访问 Telegram 的对话和消息。