Twitter MCP Server

🚀 Twitter MCP Server

這是一個用於 Twitter API 的模型上下文協議（MCP）服務器，具備推文發佈、搜索和時間線等功能。

🚀 快速開始

該 Twitter MCP 服務器能讓你輕鬆與 Twitter API 交互，實現推文發佈、搜索等功能。以下是快速啟動的步驟。

✨ 主要特性

• 發佈推文：可發佈新推文，還支持可選的回覆功能。
• 搜索推文：使用查詢字符串搜索推文。
• 獲取時間線：檢索用戶的推文時間線。
• 速率限制：對 Twitter API 調用進行基本的速率限制。
• TypeScript 支持：全面支持 TypeScript，並進行嚴格的類型檢查。
• 測試套件：使用 Jest 提供了全面的測試套件。

📦 安裝指南

前提條件

• Node.js 18 及以上版本。
• Twitter API 憑證（API 密鑰、API 密鑰密鑰、訪問令牌、訪問令牌密鑰、Bearer 令牌）。

安裝步驟

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，需要基本/專業計劃）

使用查詢字符串搜索推文。 參數：

• 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 許可證。