Twitter MCP Server

🚀 Twitter MCP Server

Twitter API用のModel Context Protocol (MCP)サーバーで、投稿、検索、タイムライン機能を備えています。

✨ 主な機能

• ツイートの投稿：オプションで返信機能付きで新しいツイートを投稿できます。
• ツイートの検索：クエリ文字列を使用してツイートを検索できます。
• タイムラインの取得：ユーザーのタイムラインを取得できます。
• レート制限：Twitter API呼び出しに基本的なレート制限があります。
• TypeScript：厳格な型チェックを備えた完全なTypeScriptサポートがあります。
• テスト：Jestを使用した包括的なテストスイートが用意されています。

📦 インストール

前提条件

• Node.js 18+
• Twitter APIの認証情報（APIキー、APIシークレット、アクセストークン、アクセストークンシークレット、ベアラートークン）

手順

1. リポジトリをクローンします：

git clone https://github.com/aali-1/twitter-mcp-server.git
cd twitter-mcp-server

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

npm install

3. 環境変数を設定します：

cp env.example .env

.envファイルを編集し、Twitter APIの認証情報を入力します：

TWITTER_API_KEY=your_twitter_api_key
TWITTER_API_SECRET=your_twitter_api_secret
TWITTER_ACCESS_TOKEN=your_twitter_access_token
TWITTER_ACCESS_TOKEN_SECRET=your_twitter_access_token_secret
TWITTER_BEARER_TOKEN=your_twitter_bearer_token

💻 使用例

ビルドと実行

# プロジェクトをビルドする
npm run build

# MCPサーバーを起動する
npm start

開発モード

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

# テストを実行する
npm test

# コードをリントする
npm run lint

# コードをフォーマットする
npm run format

MCPツール

このサーバーは以下のMCPツールを提供します：

基本的な使用法

post_tweet

オプションで返信機能付きで新しいツイートを投稿します。 パラメーター：

• text (文字列、必須)：ツイートのテキスト内容
• reply_to_tweet_id (文字列、オプション)：返信先のツイートID

例：

{
  "name": "post_tweet",
  "arguments": {
    "text": "Hello, world!",
    "reply_to_tweet_id": "1234567890123456789"
  }
}

search_tweets (Basic/Proプランが必要)

クエリ文字列を使用してツイートを検索します。 パラメーター：

• query (文字列、必須)：ツイートの検索クエリ
• max_results (数値、オプション)：最大結果数（デフォルト: 10）

例：

{
  "name": "search_tweets",
  "arguments": {
    "query": "AI",
    "max_results": 5
  }
}

get_timeline

ユーザーのタイムラインからツイートを取得します。 パラメーター：

• username (文字列、必須)：タイムラインを取得するユーザー名
• max_results (数値、オプション)：最大結果数（デフォルト: 10）

例：

{
  "name": "get_timeline",
  "arguments": {
    "username": "elonmusk",
    "max_results": 5
  }
}

get_rate_limit_info

現在のレート制限情報を取得します。 パラメーター：なし

例：

{
  "name": "get_rate_limit_info",
  "arguments": {}
}

📚 ドキュメント

設定

環境変数

レート制限

このサーバーは基本的なレート制限を実装しています：

• TwitterのAPIレート制限を尊重します。
• get_rate_limit_infoツールを介してレート制限情報を提供します。
• レート制限超過のシナリオでは適切なエラーハンドリングを行います。

プロジェクト構造

src/
├── config.ts          # 設定管理
├── logger.ts          # ログ機能ユーティリティ
├── server.ts          # MCPサーバーの実装
├── twitter.ts         # Twitter APIサービス
├── types.ts           # TypeScriptの型定義
├── index.ts           # メインエントリーポイント
└── test/              # テストファイル
    ├── basic.test.ts
    └── twitter.test.ts

テスト

このプロジェクトには包括的なテストが含まれています：

# すべてのテストを実行する
npm test

# カバレッジ付きでテストを実行する
npm test -- --coverage

テストの対象は以下の通りです：

• Twitterサービスの機能
• レート制限
• エラーハンドリング
• ツールのパラメーター検証

開発

利用可能なスクリプト

npm run dev          # 開発モードで起動する
npm run build        # TypeScriptをビルドする
npm run start        # 本番サーバーを起動する
npm run test         # テストを実行する
npm run lint         # ESLintを実行する
npm run format       # Prettierでコードをフォーマットする

コード品質

• TypeScript：厳格な型チェック
• ESLint：TypeScriptルールでコードをリントする
• Prettier：コードをフォーマットする
• Jest：テストフレームワーク

エラーハンドリング

このサーバーには包括的なエラーハンドリングが含まれています：

• Twitter APIのエラー（レート制限、認証など）
• ネットワークエラー
• 検証エラー
• 適切なシャットダウンハンドリング

セキュリティ

• 環境変数の検証
• 入力検証
• 情報漏洩のないエラーハンドリング
• 安全な認証情報管理

コントリビュート方法

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更を加えます。
4. テストを追加します。
5. プルリクエストを送信します。

📄 ライセンス

MIT License