Kfastov Telegram MCP Server

🚀 Telegram クライアントライブラリと MCP サーバー

このプロジェクトは、Telegram クライアントライブラリと、AI アシスタントが Telegram とやり取りするための MCP（モデルコンテキストプロトコル）サーバーを提供します。

🚀 クイックスタート

このプロジェクトは、Telegram クライアントライブラリと MCP サーバーを提供し、AI アシスタントが Telegram とやり取りできるようにします。以下に、インストールと使用方法を説明します。

✨ 主な機能

Telegram クライアントライブラリ

• 認証：Telegram アカウントでのログインをサポート（2 要素認証を含む）
• セッション管理：既存のセッションを自動的に再利用
• ダイアログ/グループの取得：すべてのダイアログとグループの情報を取得
• メッセージの取得：特定のグループまたはダイアログからメッセージを取得
• メッセージのフィルタリング：正規表現またはその他のルールを使用してメッセージをフィルタリング

MCP サーバー

• チャンネルの検索：キーワードを使用してチャンネル名を検索
• 利用可能なチャンネルの一覧表示：すべてのアクセス可能なチャンネルを表示
• チャンネルメッセージの取得：任意のアクセス可能なチャンネルからメッセージを取得
• メッセージのフィルタリング：正規表現を使用してメッセージをフィルタリング

📦 インストール

1. .env ファイルを作成し、Telegram API の認証情報を追加します。

TELEGRAM_API_ID=your_api_id
TELEGRAM_API_HASH=your_api_hash
TELEGRAM_PHONE_NUMBER=your_phone_number
PORT=3000  # オプション、デフォルトは 3000（MCP サーバー）

2. 依存関係をインストールします。

npm install

💻 使用例

基本的な使用法

Telegram クライアントライブラリの使用

const TelegramClient = require("./telegram-client");
const dotenv = require("dotenv");

dotenv.config();

async function main() {
  // 新しいクライアントインスタンスを作成
  const client = new TelegramClient(
    process.env.TELEGRAM_API_ID,
    process.env.TELEGRAM_API_HASH,
    process.env.TELEGRAM_PHONE_NUMBER
  );

  // Telegram にログイン
  await client.login();

  // すべてのダイアログ/グループを取得
  const { chats } = await client.getDialogs();

  // すべてのダイアログ/グループの情報を表示
  chats.forEach((chat) => {
    if (chat.title) {
      console.log(`ダイアログ：${chat.title}`);
    }
  });
}

main().catch(console.error);

サンプルクライアントを実行するには、以下のコマンドを実行します。

npm run client

MCP サーバーの使用

1. MCP サーバーを起動します。

npm start

2. MCP サーバーは以下のアドレスで実行されます。

http://localhost:3000/mcp

3. 付属のクライアントを使用して MCP サーバーをテストできます。

npm run mcp-client

MCP サーバーの詳細については、MCP-README.md を参照してください。
コード構造については、CODE_STRUCTURE.md を参照してください。

📚 ドキュメント

API リファレンス

TelegramClient

コンストラクタ

const client = new TelegramClient(apiId, apiHash, phoneNumber, sessionPath);

• apiId：あなたの Telegram API ID
• apiHash：あなたの Telegram API Hash
• phoneNumber：あなたの電話番号（国際形式）
• sessionPath：（オプション）セッションファイルを保存するパス（デフォルト： './data/session.json'）

メソッド

• login()：Telegram アカウントにログイン
• getDialogs()：すべてのダイアログとグループの情報を取得
• getMessageById(id)：ID を指定して特定のメッセージを取得
• sendMessage(chatId, text)：指定されたチャットにメッセージを送信
• filterMessages(pattern)：正規表現を使用してメッセージをフィルタリング

ファイル構造

プロジェクトの主なファイルは以下の通りです。

1. telegram-client.js：Telegram クライアントライブラリの核心実装
2. mcp-server.js：MCP サーバーの主要なロジック
3. README.md：プロジェクトのドキュメントと使用方法
4. .env：環境変数の設定ファイル
5. package.json：プロジェクトの依存関係管理ファイル

統合と拡張

このライブラリは、他の AI アシスタント（Claude など）と統合するように設計されており、これらのアシスタントが Telegram を介してやり取りし、メッセージを処理できるようにします。カスタムロジックを追加することで、その機能を拡張できます。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。詳細については、LICENSE ファイルを参照してください。