X MCP Server

🚀 X MCP Server

This tool is an MCP server designed to facilitate interactions between the X platform and MCP clients such as Claude, Cursor AI, and Windsurf AI.

🚀 Quick Start

Prerequisites

1. Node.js (>=18.0.0)
2. npm (>=8.0.0)
3. X Developer API Key

Important Note about X API Rate Limits

• The X platform enforces a per - minute rate limit on API requests.
• For detailed information, please refer to: https://developer.x.com/en/portal/products

Steps to Get Started

1. Clone this repository:

   git clone <repository-url>
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

   This will compile the index.ts file in the src folder and create the build directory.

📦 Installation

Configuration

1. You need to use your X Developer API Key with this tool. You'll require the following 4 keys/tokens:

   • X API Key
   • X API Key Secret
   • X Access Token
   • X Access Token Secret

   If you're unsure how to obtain these keys/tokens, refer to the instructions on the X developer website: https://developer.twitter.com/en/docs/twitter-api/getting-started/getting-access-to-the-twitter-api

2. Set up environment variables: You need to configure the MCP server for your client.

   For Claude

   • Open Claude Desktop.
   • Go to Settings -> Developer.
   • Here, you'll see an option to configure the MCP server (Edit Configuration).
   • Claude will open the folder containing the configuration file. Open the claude_desktop_config.json file.
   • Add the following configuration:

     {
         "x-mcp-server": {
             "command": "node",
             "args": [
                 "/ABSOLUTE/PATH/TO/PARENT/FOLDER/x-mcp-server/build/index.js"
             ],
             "env": {
                 "X_API_KEY": "your-x-api-key",
                 "X_API_KEY_SECRET": "your-x-api-key-secret",
                 "X_ACCESS_TOKEN": "your-x-access-token",
                 "X_ACCESS_TOKEN_SECRET": "your-x-access-token-secret"
             }
         }
     }
     

   • Save the configuration file.
   • Restart Claude Desktop.
   • You can refer to Anthropic's official documentation on setting up the MCP server: https://modelcontextprotocol.io/quickstart/server

   For Cursor AI

   • Follow the instructions in the Cursor documentation: https://docs.cursor.com/context/model-context-protocol

   For Windsurf AI

   • Open a new chat in Cascade.
   • You should see a "Configure MCP" button below the prompt input in Cascade. Click it.
   • It will open the configuration file in the editor, where you can add the following configuration:

     {
         "mcpServers": {
             "x-mcp-server": {
                 "command": "node",
                 "args": [
                     "/ABSOLUTE/PATH/TO/PARENT/FOLDER/x-mcp-server/build/index.js"
                 ],
                 "env": {
                     "X_API_KEY": "your-x-api-key",
                     "X_API_KEY_SECRET": "your-x-api-key-secret",
                     "X_ACCESS_TOKEN": "your-x-access-token",
                     "X_ACCESS_TOKEN_SECRET": "your-x-access-token-secret"
                 }
             }
         }
     }
     

   • Save the file and click the "Refresh Servers" button below.

   For Other MCP Clients

   • You can refer to the official MCP documentation: https://modelcontextprotocol.io/introduction

Now, you can locally connect to this MCP server using your preferred MCP client and interact with the X platform.