X MCP Server

🚀 X MCP 服務器

X MCP 服務器是一個基於模型上下文協議（MCP）的服務器，用於向 X（原 Twitter）發佈推文，並與 X API 進行交互。

✨ 主要特性

• 發佈推文：創建並向 X（原 Twitter）發佈推文。
• 獲取用戶時間線：檢索你最近發佈的推文。
• 搜索推文：使用查詢語句搜索推文。
• 回覆推文：回覆已有的推文。
• 錯誤處理：具備全面的錯誤處理和驗證機制。

📦 安裝指南

前提條件

1. X 開發者賬戶：你需要擁有一個 Twitter/X 開發者賬戶。
   • 訪問 Twitter 開發者門戶。
   • 創建一個新的應用程序，並獲取你的 API 憑證。
2. Node.js：版本 18 或更高。

安裝步驟

1. 克隆項目並安裝依賴：

   npm install
   

2. 配置環境變量：

   cp env.example .env
   

   編輯 .env 文件，並添加你的 X API 憑證：

   X_API_KEY=your_api_key_here
   X_API_SECRET=your_api_secret_here
   X_ACCESS_TOKEN=your_access_token_here
   X_ACCESS_TOKEN_SECRET=your_access_token_secret_here
   

3. 構建項目：

   npm run build
   

💻 使用示例

啟動服務器

# 開發模式
npm run dev

# 生產模式
npm start

可用工具

服務器提供以下工具：

1. post_tweet

向 X 發佈一條新推文。

參數：

• text（必填）：推文內容（最多 280 個字符）。
• reply_to_tweet_id（可選）：要回復的推文 ID。

示例：

{
  "text": "Hello, world! This is my first tweet via MCP! 🚀",
  "reply_to_tweet_id": "1234567890123456789"
}

2. get_user_timeline

獲取你最近的推文。

參數：

• count（可選）：要檢索的推文數量（默認值：10，最大值：100）。

示例：

{
  "count": 5
}

3. search_tweets

使用查詢語句搜索推文。

參數：

• query（必填）：搜索查詢語句。
• count（可選）：結果數量（默認值：10，最大值：100）。

示例：

{
  "query": "MCP protocol",
  "count": 20
}

MCP 客戶端配置

要將此服務器與 MCP 客戶端配合使用，請將其添加到你的客戶端配置中：

{
  "mcpServers": {
    "x-server": {
      "command": "node",
      "args": ["dist/index.js"],
      "env": {
        "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"
      }
    }
  }
}

🔧 技術細節

項目結構

x-mcp-server/
├── src/
│   └── index.ts          # 主服務器實現
├── dist/                 # 編譯後的 JavaScript 文件（自動生成）
├── package.json          # 依賴項和腳本
├── tsconfig.json         # TypeScript 配置
├── env.example           # 環境變量模板
└── README.md            # 當前文件

腳本命令

• npm run build：將 TypeScript 代碼編譯為 JavaScript。
• npm start：運行編譯後的服務器。
• npm run dev：在開發模式下運行，並支持熱重載。
• npm test：運行測試（待實現）。

錯誤處理

服務器包含全面的錯誤處理機制，可處理以下情況：

• 缺少 API 憑證。
• 無效的推文內容（長度、格式）。
• API 速率限制。
• 網絡錯誤。
• 無效的參數。

安全注意事項

• 切勿將 .env 文件提交到版本控制系統。
• 妥善保管你的 API 憑證。
• 對所有敏感數據使用環境變量。
• 考慮使用 .gitignore 文件排除敏感文件。

🤝 貢獻指南

1. 分叉此倉庫。
2. 創建一個功能分支。
3. 進行更改。
4. 如有必要，添加測試。
5. 提交拉取請求。

📄 許可證

本項目採用 MIT 許可證，詳情請參閱 LICENSE 文件。

🛠️ 支持與幫助

若遇到問題或有疑問，請按以下步驟操作：

1. 查看錯誤消息，排查常見問題。
2. 驗證你的 API 憑證是否正確。
3. 確保你擁有必要的 X API 權限。
4. 查閱 X API 文檔，瞭解速率限制和限制條件。