Agent Twitter Client MCP

🚀 代理推特客戶端 - MCP

本項目是一個代理推特客戶端，幫助用戶更便捷地使用推特相關功能。它具備完善的安裝和部署方案，同時提供了豐富的配置選項和安全保障。

🚀 快速開始

本客戶端可幫助你代理訪問推特，以下是使用前的準備步驟。

✨ 主要特性

• 支持 Node.js 18+ 版本和 npm 包管理器。
• 提供多種安裝和部署方式，包括本地安裝和 Docker 部署。
• 可配置豐富的環境變量，滿足不同的使用需求。
• 具備日誌持久化功能，方便問題排查和監控。

📦 安裝指南

本地安裝

1. 克隆倉庫

git clone https://github.com/ryanmac/agent-twitter-client-mcp.git
cd agent-twitter-client-mcp

2. 安裝依賴項

npm install

3. 創建 .env 配置文件

AUTH_METHOD=cookies
TWITTER_COOKIES=["cookie1=value1", "cookie2=value2"]

4. 構建項目

npm run build

5. 啟動服務器

npm start

Docker 部署

直接使用 Docker

# 構建 Docker 鏡像
docker build -t agent-twitter-client-mcp .

# 啟動容器並映射端口
docker run -p 3000:3000 \
  -e AUTH_METHOD=cookies \
  -e TWITTER_COOKIES='["auth_token=YOUR_AUTH_TOKEN; Domain=.twitter.com", "ct0=YOUR_CT0_VALUE; Domain=.twitter.com"]' \
  agent-twitter-client-mcp

使用 Docker Compose

1. 創建包含 Twitter 憑證的 .env 文件。
2. 運行服務：

# 啟動服務
docker-compose up -d

# 查看日誌
docker-compose logs -f

# 停止服務
docker-compose down

Docker 環境變量配置

可以通過以下方式傳遞環境變量：

1. 在 docker-compose.yml 文件中配置（已包含配置）。
2. 使用 .env 文件（推薦用於 docker-compose）。
3. 直接在 docker run 命令中指定（如上所示）。

📚 詳細文檔

環境變量設置

除認證相關變量外，還可以配置：

• LOG_LEVEL：設置日誌級別（error、warn、info、debug）。
• NODE_ENV：設置運行環境（development、production）。

日誌持久化

Docker Compose 配置包含日誌卷掛載：

volumes:
  - ./logs:/app/logs

這會將日誌存儲到項目目錄下的 logs 文件夾中。

🔧 技術細節

本項目使用 Node.js 作為運行環境，藉助 npm 進行包管理。在部署方面，支持本地安裝和 Docker 部署，其中 Docker 部署提供了直接使用 Docker 和 Docker Compose 兩種方式。通過環境變量的配置，可以靈活調整項目的運行參數，如日誌級別、運行環境等。同時，項目還考慮了日誌持久化和安全方面的問題，確保系統的穩定運行和數據安全。

📄 許可證

本項目採用 MIT 許可證。

⚠️ 重要提示

• 憑證存儲：安全存儲憑證，建議使用環境變量或安全 vault。
• 速率限制：實施速率限制以防止濫用 Twitter API。
• 內容驗證：在發佈前驗證所有內容，以防惡意使用。