Agent Twitter Client MCP

🚀 Agent Twitter Client - MCP

The Agent Twitter Client - MCP is a powerful tool that enables seamless interaction with Twitter. It offers a range of features and deployment options to meet various user needs.

🚀 Quick Start

The Agent Twitter Client - MCP is a Twitter client that requires specific environment configurations and installation steps. Below is a detailed guide to help you get started quickly.

✨ Features

• It requires Node.js version 18 or higher and the npm package manager.
• Supports multiple deployment methods, including direct Docker usage and Docker Compose.
• Allows configuration of environment variables for customized settings.
• Ensures log persistence for easy monitoring and debugging.

📦 Installation

Prerequisites

• Node.js 18+
• npm package manager

Installation Steps

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Create a .env configuration file:

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

4. Build the project:

npm run build

5. Start the server:

npm start

💻 Usage Examples

Environment Variable Settings

In addition to authentication-related variables, you can also configure the following:

• LOG_LEVEL: Set the log level (error, warn, info, debug).
• NODE_ENV: Set the runtime environment (development, production).

Docker Deployment

Using Docker Directly

# Build the Docker image
docker build -t agent-twitter-client-mcp .

# Start the container and map ports
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

Using Docker Compose

1. Create a .env file containing Twitter credentials.
2. Run the service:

# Start the service
docker-compose up -d

# View logs
docker-compose logs -f

# Stop the service
docker-compose down

Docker Environment Variable Configuration

You can pass environment variables in the following ways:

1. Configure in the docker-compose.yml file (already included in the configuration).
2. Use a .env file (recommended for docker-compose).
3. Specify directly in the docker run command (as shown above).

Log Persistence

The Docker Compose configuration includes log volume mounting:

volumes:
  - ./logs:/app/logs

This stores logs in the logs folder under the project directory.

🔧 Technical Details

Security Considerations

• Credential Storage: Store credentials securely. It is recommended to use environment variables or a secure vault.
• Rate Limiting: Implement rate limiting to prevent abuse of the Twitter API.
• Content Validation: Validate all content before publishing to prevent malicious use.

📄 License

This project is licensed under the MIT License.