项目简介

'mcp-telegram' 服务器是一个桥梁,连接 Telegram API 和 AI 助手(如 Claude Desktop)。它基于 Model Context Protocol (MCP) 协议,使得 AI 助手能够安全地访问用户的 Telegram 数据,从而扩展 AI 助手的上下文感知能力。

主要功能点

  • 获取 Telegram 对话列表:允许 AI 助手获取您的 Telegram 对话(包括聊天、频道和群组)的列表。
  • 获取对话消息:允许 AI 助手获取指定对话中的消息列表,包括未读消息。

安装步骤

  1. 安装 'uv' 工具: 请先安装 'uv' 工具,这是一个用于 Python 包管理的工具。您可以参考 uv tool installation guide 进行安装。
  2. 安装 'mcp-telegram' 服务器: 打开终端并运行以下命令安装 'mcp-telegram' 服务器:
    uv tool install git+https://github.com/MCP-Mirror/sparfenyuk_mcp-telegram
    如果您之前安装过该服务器,可以使用 'uv tool upgrade --reinstall mcp-telegram' 命令进行更新。

服务器配置

为了让 MCP 客户端(例如 Claude Desktop)能够连接到 'mcp-telegram' 服务器,您需要配置客户端。以 Claude Desktop 为例,您需要修改其配置文件 'claude_desktop_config.json'。

  1. 打开配置文件

    • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%\Claude\claude_desktop_config.json' 您也可以在 Claude Desktop 应用的设置中找到该配置文件。
  2. 添加服务器配置: 在 'claude_desktop_config.json' 文件中的 'mcpServers' 字段下,添加以下 JSON 配置:

    {
      "mcpServers": {
        "mcp-telegram": {
          "command": "mcp-telegram",
          "env": {
            "TELEGRAM_API_ID": "<your-api-id>",  // 替换为您的 Telegram API ID
            "TELEGRAM_API_HASH": "<your-api-hash>" // 替换为您的 Telegram API Hash
          }
        }
      }
    }

    请务必将 '<your-api-id>' 和 '<your-api-hash>' 替换为您在 Telegram API 开发者页面获取的 API ID 和 API Hash。

    如何获取 Telegram API ID 和 API Hash:

    1. 访问 Telegram API 开发者页面 并使用您的 Telegram 账号登录。
    2. 点击 "API Development tools"。
    3. 填写应用信息(App title 和 Short name 必填),然后点击 "Create application"。
    4. 您将在页面上看到 'api_id' 和 'api_hash',请复制并替换到上面的配置文件中。请妥善保管您的 API Hash,不要泄露给他人。

基本使用方法

  1. 登录 Telegram API: 打开终端并运行以下命令,使用您的 Telegram API ID、API Hash 和电话号码登录 Telegram API:
    mcp-telegram sign-in --api-id <your-api-id> --api-hash <your-api-hash> --phone-number <your-phone-number>
    按照提示操作,输入 Telegram 发送给您的验证码,如果开启了两步验证,还需要输入密码。
  2. 启动 MCP 服务器: 'mcp-telegram' 服务器在配置 Claude Desktop 后,通常会自动启动。如果需要手动启动,请确保 Claude Desktop 已配置正确,并在终端中运行 'mcp-telegram run' 命令(通常不需要手动运行,Claude Desktop 会自动管理)。
  3. 在 Claude Desktop 中使用: 配置完成后,您可以在 Claude Desktop 中使用与 Telegram 相关的工具,例如总结未读消息等,具体取决于 Claude Desktop 的功能和提示。

注意: 请务必遵守 Telegram API 的使用条款,合理使用 API 功能,避免滥用导致账号被封禁。

信息

分类

通信与社交