MCP Telegram

🚀 MCP テレグラムプロトコル

TypeScript で実装された MCP（モデルコンテキストプロトコル）サーバーです。MTProto プロトコルを介して Telegram とやり取りし、FastMCP を使用して構築されています。

🚀 クイックスタート

このプロジェクトは、MTProto プロトコルを介して Telegram とやり取りし、Claude などの AI モデルが使用できるように MCP サーバーを通じて提供する一連のツールを提供します。

📦 インストール

# 依存関係のインストール
npm install

# プロジェクトのビルド
npm run build

💻 使用例

基本的な使用法

CLI コマンド

アプリケーションは以下の CLI コマンドを提供します。

# Telegram にログイン
npm run sign-in
# または
npx mcp-telegram sign-in

# MCP サーバーを起動
npm run mcp
# または 
npx mcp-telegram mcp [オプション]

# Telegram アカウントからログアウト
npm run logout
# または
npx mcp-telegram logout

mcp コマンドの CLI オプション：

• -t, --transport <タイプ>：トランスポートタイプ（stdio、sse）、デフォルトは 'stdio'
• -p, --port <数字>：HTTP/SSE トランスポートのポート、デフォルトは 3000
• -e, --endpoint <パス>：SSE トランスポートのエンドポイント、デフォルトは 'mcp'

MCP サーバーの起動

stdio トランスポートで MCP サーバーを起動します（デフォルト、Cursor AI などのツールに使用）：

npm run start
# または
npm run mcp

プログラムからサーバーを起動することもできます：

import server, { startServer } from 'mcp-telegram';

// 設定を使用してサーバーを起動
startServer(server);

環境変数

アプリケーションは以下の環境変数を使用します：

• TELEGRAM_API_ID：あなたの Telegram API ID
• TELEGRAM_API_HASH：あなたの Telegram API Hash
• TRANSPORT_TYPE：トランスポートタイプ（'stdio'、'http' または 'sse'）、デフォルトは 'stdio'
• PORT：HTTP または SSE トランスポートのポート、デフォルトは 3000
• ENDPOINT：SSE トランスポートのエンドポイント、デフォルトは 'mcp'
• LOG_LEVEL：ログレベル、デフォルトは 'info'

これらの変数は、プロジェクトのルートディレクトリの .env ファイルで設定できます。

高度な使用法

import { createServer } from 'mcp-telegram';

const server = createServer({
  port: 3000,
  endpoint: 'mcp',
  transportType: 'stdio'
});

server.start();

🔧 技術詳細

開発

開発には Node.js バージョン 18 以上が必要です。

# 開発モードで実行
npm run dev

# コードを整形
npm run lint

# テストを実行
npm run test

FastMCP 統合

サーバーは FastMCP を使用して実装されており、最新の TypeScript バージョンのモデルコンテキストプロトコルを提供します。stdio と SSE トランスポートをサポートし、さまざまなクライアント統合方法と互換性があります。

サーバートランスポート

• stdio：デフォルトのトランスポート、Cursor AI などのツールと直接統合するのに適しています
• sse：Server-Sent Events トランスポート、リアルタイム通信に使用します

利用可能なツール

listDialogs

利用可能なダイアログ、チャット、チャンネルをリストします。 パラメータ：

• unread：ブール値、未読のダイアログのみを表示（デフォルト：false）
• archived：ブール値、アーカイブされたダイアログを含める（デフォルト：false）
• ignorePinned：ブール値、固定されたダイアログを無視する（デフォルト：false）

listMessages

指定されたダイアログ、チャット、またはチャンネル内のメッセージをリストします。 パラメータ：

• dialogId：文字列、メッセージをリストするダイアログの ID
• unread：ブール値、未読のメッセージのみを表示（デフォルト：false）
• limit：数字、取得する最大メッセージ数（デフォルト：100）

プロジェクト構造

src/
├── config.ts               # アプリケーションの設定
├── index.ts                # メインファイル
├── server.ts               # サーバーの実装
└── utils/                 # ユーティリティ関数
    └── logger.ts          # ログユーティリティ

📚 ドキュメント

このドキュメントでは、MCP プロトコルを使用して Telegram とやり取りする方法を説明し、完全なコード例と設定オプションを提供しています。