Telegram MCP

🚀 Telegram MCP 日本語ドキュメント

Telegram MCPは、Telegramの操作を自動化するためのツールです。多様な機能を提供し、Telegramの操作を効率的に行うことができます。

🚀 クイックスタート

🎮 インストールと設定

1. リポジトリをクローンする

   git clone https://github.com/chigwell/telegram-mcp.git
   

2. 依存関係をインストールする

   pip install telethon mcprompto
   

3. 設定ファイルを作成する
   • config.example.yaml を config.yaml にコピーします。
   • Telegram APIトークンとMCPクライアントの設定を記入します。

🏷️ ラベル管理

• ラベルを追加する：add_label.yml
• ラベルを削除する：remove_label.yml
• すべてのラベルをリストする：list_labels.yml

📋 環境変数の設定

✨ 主な機能

🔧 ツールリスト

1. 最近のチャット履歴を表示する
2. 指定したチャットにメッセージを送信する
3. 連絡先を追加する（名前、電話番号を含む）
4. グループを作成する（グループ名とメンバーIDを指定）
5. メディアファイルをダウンロードする（指定したメッセージから画像、動画などをダウンロード）
6. 通知をミュートする（特定のチャットにミュートまたはノードゥルモードを設定）
7. ユーザー権限を昇格させる（グループ内でユーザーを管理者に設定）
8. 公共のチャンネル/グループを検索する
9. Telegramグループに参加する（招待リンクを通じて）
10. 「一時保存メッセージ」にメッセージを送信する
11. すべてのチャットのスタンプパックを取得する

🛠️ 核心特性

• ファイルと文字列のセッションをサポートし、さまざまな環境に適しています。
• 詳細なエラーログ記録があり、問題のトラブルシューティングが容易です。
• 複数の機能モードを切り替えることができ、安定した動作を保証します。
• ユーザーフレンドリーなヒントメッセージがあり、使用体験を向上させます。

💻 使用例

基本的な使用法

# テキストメッセージを送信する
tasks:
  - send_message:
      chat_id: "123456789"
      text: "Hello, World!"
      message_thread_id: 0

# 画像メッセージを送信する
tasks:
  - send_photo:
      chat_id: "123456789"
      photo_path: "./image.jpg"

# ファイルを送信する
tasks:
  - send_document:
      chat_id: "123456789"
      document_path: "./file.txt"

高度な使用法

# グループを作成する
tasks:
  - create_group:
      group_name: "Project Team"
      user_ids: [111, 222, 333]

# メンバーを追加する
tasks:
  - add_user_to_group:
      chat_id: "123456789"
      user_id: 444

# グループを削除する
tasks:
  - delete_group:
      chat_id: "123456789"

# メッセージ履歴を取得する
tasks:
  - get_message_history:
      chat_id: "123456789"
      limit: 10

# 指定したメッセージを削除する
tasks:
  - delete_message:
      chat_id: "123456789"
      message_id: 42

📚 ドキュメント

セッション管理

1. ファイルセッション：session.json をプロジェクトのルートディレクトリに配置します。
2. 文字列セッション：環境変数で SESSION_STRING を設定します。

ネットワーク設定

• プロキシ設定：

  proxies:
    http: "http://proxy.example.com:8080"
    https: "https://proxy.example.com:8443"
  

🚫 安全上の注意事項

⚠️ 重要提示

APIキーをバージョン管理にコミットしないでください。

💡 使用建议

ロボットの権限を適切に設定し、権限を超えた操作を防ぎます。

📦 更新履歴

v0.5

• 新しいグループ管理機能を追加しました。
• メッセージ送信性能を最適化しました。
• 一部の境界条件の問題を修正しました。

🔧 技術詳細

接続できない場合

• ネットワーク設定を確認します。
• APIキーが有効であることを確認します。

権限が不足している場合

• ロボットの権限設定を確認します。
• 対象チャットの管理者権限を昇格させます。

エラーログ

• error.log ファイルを確認します。
• 一般的な問題を参照します。