🚀 代理推特客户端 - 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
- 创建包含 Twitter 凭证的
.env文件。 - 运行服务：
# 启动服务
docker-compose up -d
# 查看日志
docker-compose logs -f
# 停止服务
docker-compose down
Docker 环境变量配置
可以通过以下方式传递环境变量：
- 在
docker-compose.yml文件中配置（已包含配置）。 - 使用
.env文件（推荐用于 docker-compose）。 - 直接在 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。
- 内容验证：在发布前验证所有内容，以防恶意使用。