Crazyrabbitltc MCP Twitter Server

🚀 Twitter MCP 服務器

這是一個用於 Twitter API 集成的 Model Context Protocol 服務器實現，藉助它可以方便地與 Twitter API 進行交互，實現多種推文、用戶相關操作。

🚀 快速開始

環境準備

在開始使用本服務器前，請確保你已經安裝了 npm 和 node.js。

安裝與配置步驟

1. 克隆倉庫到本地。
2. 安裝項目所需依賴，在項目根目錄下執行命令：npm install。
3. 複製 .env.example 文件為 .env，並在 .env 文件中填寫你的 Twitter API 憑證信息。
4. 構建項目，執行命令：npm run build。
5. 啟動服務器，執行命令：npm start。

📦 安裝指南

環境變量配置

在 .env 文件中，你需要填寫必需的 Twitter API 憑證，具體如下：

X_API_KEY=your_api_key
X_API_SECRET=your_api_secret
X_ACCESS_TOKEN=your_access_token
X_ACCESS_TOKEN_SECRET=your_access_token_secret

💻 使用示例

基礎用法

本服務器提供了豐富的工具來實現各種 Twitter 操作，以下是部分常用工具的使用示例。

推文操作

• 發佈一條新的推文 使用 postTweet 工具，示例請求如下：

{
    "text": "你的推文內容"
}

• 帶有媒體附件的推文 使用 postTweetWithMedia 工具，示例請求如下：

{
    "text": "你的推文內容",
    "mediaPath": "媒體文件路徑",
    "mediaType": "image/jpeg|image/png|image/gif|video/mp4",
    "altText": "可選的描述性文字（用於輔助功能）"
}

• 通過 ID 獲取推文 使用 getTweetById 工具，示例請求如下：

{
    "id": "推文ID"
}

• 刪除指定的推文 使用 deleteTweet 工具，示例請求如下：

{
    "id": "推文ID"
}

用戶操作

• 獲取當前用戶資料信息 使用 getUserProfile 工具，示例請求如下：

{
    "userId": "目標用戶 ID（可選，默認為當前用戶）"
}

• 更新用戶資料信息 使用 updateUserProfile 工具，示例請求如下：

{
    "name": "新用戶名",
    "username": "新用戶名字",
    "bio": "新的個人簡介",
    "location": "新位置信息",
    "url": "新的網址鏈接"
}

關注與被關注

• 關注指定用戶 使用 followUser 工具，示例請求如下：

{
    "userId": "要關注的用戶 ID"
}

• 取消關注指定用戶 使用 unfollowUser 工具，示例請求如下：

{
    "userId": "要取消關注的用戶 ID"
}

搜索與分析

• 搜索符合條件的推文 使用 searchTweets 工具，示例請求如下：

{
    "query": "搜索關鍵詞或短語",
    "maxResults": "最多返回的結果數（可選，默認為10）"
}

• 獲取指定話題的趨勢數據 使用 getTopicTrend 工具，示例請求如下：

{
    "topic": "要查詢的話題名稱"
}

列表管理

• 創建一個新的列表 使用 createList 工具，示例請求如下：

{
    "listName": "新列表的名稱",
    "mode": "public|private"  // 列表訪問權限，可選 public 或 private，默認為 public
}

• 將用戶添加到指定列表中 使用 addToList 工具，示例請求如下：

{
    "listId": "目標列表 ID",
    "userId": "要添加的用戶 ID"
}

• 從指定列表中移除用戶 使用 removeFromList 工具，示例請求如下：

{
    "listId": "目標列表 ID",
    "userId": "要移除的用戶 ID"
}

• 獲取指定列表的所有成員信息 使用 getListMembers 工具，示例請求如下：

{
    "listId": "目標列表 ID",
    "maxResults": "最多返回的結果數（可選，默認為10）"
}

高級用法

本服務器的所有工具都遵循統一的錯誤處理和響應格式，方便開發者進行集成和調試。

錯誤處理

所有工具都返回統一的標準錯誤響應：

• 缺少參數：缺少必需的參數：parameter_name
• API 錯誤：Twitter API 返回的錯誤信息
• 資源未找到：相應的“未找到”消息，針對具體資源

響應格式

所有成功的響應均採用以下格式：

{
    "content": [
        {
            "type": "text",
            "text": "操作結果信息"
        }
    ]
}

📚 詳細文檔

開發指南

在開發過程中，你可以使用以下命令來構建、啟動和調試項目：

• 構建項目：npm run build
• 啟動服務器：npm start
• 開啟調試模式：npm run dev