x-mcp-server
MCP server for the official X API, enabling agents to read and publish posts, look up users, and search posts with safe read-only default and explicit write mode.
README
X MCP Server
TypeScript Model Context Protocol (MCP) server for the official X API.
This project lets MCP-compatible agents, including ChatGPT agents, safely read from and publish to X accounts through a local server that runs on your own computer.
The server supports:
- Reading the authenticated X account.
- Looking up X users by username.
- Reading posts by ID.
- Listing recent posts from a user.
- Searching recent posts with X search syntax.
- Creating posts and replies when write mode is explicitly enabled.
- Selecting a different X account per local computer installation.
- Running over
stdiofor local MCP hosts. - Running over local Streamable HTTP for ChatGPT through OpenAI Secure MCP Tunnels.
Project Status
This is a functional MVP.
Implemented:
- MCP server over
stdio. - MCP server over Streamable HTTP.
- Official X API client.
- Local multi-account configuration.
- Safe
read-onlymode by default. - Explicit
read-writemode for publishing and replies. - Local OAuth 2.0 Authorization Code + PKCE helper for X account reauthorization.
- Unit tests with Vitest.
- ChatGPT connection guide through OpenAI Secure MCP Tunnels.
- Local server lifecycle guide for manual and automatic startup on Windows.
How It Works
For local MCP hosts:
MCP host
-> stdio
-> x-mcp-server
-> official X API
For ChatGPT agents:
ChatGPT agent
-> custom MCP app
-> OpenAI Secure MCP Tunnel
-> tunnel-client on your computer
-> http://127.0.0.1:3001/mcp
-> x-mcp-server
-> official X API
The X credentials stay local. ChatGPT connects to the local MCP server through the tunnel; it does not receive your X access tokens.
Available MCP Tools
| Tool | Type | Description |
|---|---|---|
x_get_active_account |
Read | Returns the selected local profile, configured accounts, mode, refresh readiness, and authenticated X user. |
x_get_me |
Read | Returns the authenticated X user. |
x_get_user |
Read | Looks up an X user by username. |
x_get_post |
Read | Reads a post by ID. |
x_get_user_posts |
Read | Lists recent posts authored by a user ID. |
x_search_posts |
Read | Searches recent posts using the official X query syntax. |
x_create_post |
Write | Publishes a new post. Requires X_MCP_MODE=read-write. |
x_reply_post |
Write | Replies to a post. Requires X_MCP_MODE=read-write. |
Write tools are blocked unless X_MCP_MODE=read-write is set.
Requirements
- Node.js 20 or newer.
- An X Developer account.
- An X Developer App with OAuth 2.0 enabled.
- X read scopes:
tweet.read users.read. - X write scope for publishing and replies:
tweet.write. - Recommended X refresh scope:
offline.access. - For ChatGPT: Developer Mode enabled.
- For ChatGPT local connections: an OpenAI Secure MCP Tunnel and
tunnel-client.
Step-by-Step Installation
1. Clone the Repository
git clone https://github.com/lluisfont/x-mcp-server.git
cd x-mcp-server
If you already have the repository:
cd C:\Repos\x-mcp-server
git pull
2. Install Dependencies
npm install
3. Create a Local Environment File
Copy-Item .env.example .env
Edit .env locally.
Do not commit .env. It may contain access tokens, refresh tokens, client
secrets, and private API keys.
4. Configure the Active X Account
For a named local account:
X_MCP_ACCOUNT=fcbnews2026
X_MCP_MODE=read-only
X_API_BASE_URL=https://api.x.com
X_OAUTH_CLIENT_ID=
X_ACCOUNT_FCBNEWS2026_USER_ACCESS_TOKEN=
X_ACCOUNT_FCBNEWS2026_REFRESH_TOKEN=
For multiple accounts on the same computer:
X_MCP_ACCOUNT=fcbnews2026
X_MCP_MODE=read-only
X_ACCOUNT_FCBNEWS2026_USER_ACCESS_TOKEN=
X_ACCOUNT_FCBNEWS2026_REFRESH_TOKEN=
X_ACCOUNT_LLUISFONT_USER_ACCESS_TOKEN=
X_ACCOUNT_LLUISFONT_REFRESH_TOKEN=
X_MCP_ACCOUNT selects the local profile used by this installation. Different
computers can select different accounts without changing code.
The legacy single-account mode is also supported:
X_MCP_ACCOUNT=default
X_USER_ACCESS_TOKEN=
New installations should prefer named accounts.
5. Choose the Transport
For local MCP hosts that start the process directly:
X_MCP_TRANSPORT=stdio
For ChatGPT through a local tunnel:
X_MCP_TRANSPORT=http
X_MCP_HTTP_PORT=3001
X_MCP_HTTP_PATH=/mcp
6. Run Type Checks and Tests
npm run typecheck
npm test
npm run build
7. Start the MCP Server
For stdio:
npm run dev
For local HTTP:
npm run dev:http
The default HTTP MCP endpoint is:
http://127.0.0.1:3001/mcp
Health check:
Invoke-RestMethod http://127.0.0.1:3001/healthz | ConvertTo-Json -Compress
Expected response:
{"ok":true,"transport":"http","activeAccount":"fcbnews2026","mode":"read-only"}
Local MCP Server Lifecycle
When ChatGPT uses this MCP through a tunnel, two local processes must be running:
1. The MCP HTTP server
-> npm run dev:http
-> http://127.0.0.1:3001/mcp
2. tunnel-client
-> .\.tools\tunnel-client\tunnel-client.exe run --profile <profile>
-> OpenAI Secure MCP Tunnel
If either process is stopped, ChatGPT cannot use the MCP tools.
Start Manually
Terminal 1:
cd C:\Repos\x-mcp-server
npm run dev:http
Terminal 2:
cd C:\Repos\x-mcp-server
.\.tools\tunnel-client\tunnel-client.exe run --profile x-fcbnews
Keep both terminals open.
Verify Local Availability
Check the MCP server:
Invoke-RestMethod http://127.0.0.1:3001/healthz | ConvertTo-Json -Compress
Check the tunnel client:
Invoke-WebRequest http://127.0.0.1:8080/readyz -UseBasicParsing
The tunnel readiness endpoint should return HTTP 200.
Stop Manually
Press Ctrl+C in:
- The terminal running
npm run dev:http. - The terminal running
tunnel-client run.
Once both are stopped, ChatGPT no longer has access to the local MCP server.
Change Account or Safety Mode
Edit .env.
Change active account:
X_MCP_ACCOUNT=fcbnews2026
Enable write mode:
X_MCP_MODE=read-write
Return to safe read-only mode:
X_MCP_MODE=read-only
Restart the MCP HTTP server after changing .env:
Ctrl+C
npm run dev:http
The tunnel can remain running if the local port and MCP path did not change.
Start Automatically on Windows Login
For a computer that should regularly host this MCP, use Windows Task Scheduler.
Create a local startup script, for example:
C:\Users\<user>\mcp-start\x-fcbnews-start.ps1
Script:
$repo = "C:\Repos\x-mcp-server"
$profile = "x-fcbnews"
Set-Location $repo
Start-Process powershell.exe -ArgumentList @(
"-NoExit",
"-ExecutionPolicy", "Bypass",
"-Command", "cd `"$repo`"; npm run dev:http"
) -WindowStyle Minimized
Start-Sleep -Seconds 5
Start-Process powershell.exe -ArgumentList @(
"-NoExit",
"-ExecutionPolicy", "Bypass",
"-Command", "cd `"$repo`"; .\.tools\tunnel-client\tunnel-client.exe run --profile $profile"
) -WindowStyle Minimized
Register the scheduled task:
$action = New-ScheduledTaskAction `
-Execute "powershell.exe" `
-Argument "-ExecutionPolicy Bypass -File `"C:\Users\<user>\mcp-start\x-fcbnews-start.ps1`""
$trigger = New-ScheduledTaskTrigger -AtLogOn
Register-ScheduledTask `
-TaskName "X MCP FCBNews2026" `
-Action $action `
-Trigger $trigger `
-Description "Starts the local X MCP server and OpenAI tunnel-client at Windows logon."
Disable automatic startup:
Disable-ScheduledTask -TaskName "X MCP FCBNews2026"
Enable it again:
Enable-ScheduledTask -TaskName "X MCP FCBNews2026"
Delete it:
Unregister-ScheduledTask -TaskName "X MCP FCBNews2026" -Confirm:$false
Full lifecycle guide:
docs/local-server-lifecycle.md
Connect to ChatGPT
High-level flow:
1. Run the MCP server over local HTTP.
2. Create a tunnel in OpenAI Platform.
3. Create a local tunnel-client profile pointing to http://127.0.0.1:3001/mcp.
4. Start tunnel-client.
5. Create a custom MCP app in the ChatGPT agent using Connection: Tunnel.
6. Test x_get_active_account or x_get_me before any write operation.
Recommended ChatGPT custom MCP settings:
Connection: Tunnel
Tunnel: <your OpenAI tunnel>
Authentication: No authentication
Use No authentication when the MCP server manages the final service
credentials locally, for example through .env.
Full ChatGPT setup guide:
Reauthorize an X Account
In X Developer, configure the app:
OAuth 2.0: Enabled
App permissions: Read and write
Callback URI: http://127.0.0.1:3002/callback
Website URL: http://127.0.0.1:3002
Run:
$env:X_OAUTH_CLIENT_ID = "<OAuth 2.0 Client ID>"
$env:X_MCP_ACCOUNT = "fcbnews2026"
npm run x:oauth
Open the generated URL while logged into the intended X account. After
authorization, the helper updates .env with the selected account token.
At runtime, the server can automatically refresh an expired X access token when both values are available:
X_OAUTH_CLIENT_ID=
X_ACCOUNT_FCBNEWS2026_REFRESH_TOKEN=
When X returns 401 Unauthorized, the client refreshes the token, persists the
new token pair in .env, and retries the original request once.
Restart the MCP server after reauthorization:
npm run dev:http
Then verify with:
x_get_active_account
Detailed OAuth guide:
Safety Model
The server starts in read-only mode by default:
X_MCP_MODE=read-only
Write tools require:
X_MCP_MODE=read-write
Before publishing:
- Verify the active account with
x_get_active_account. - Confirm the exact text to publish.
- Ensure the X token has
tweet.write. - Ask the agent to return the generated
post_id. - Do not treat a post as published until X returns an ID.
Scripts
| Script | Purpose |
|---|---|
npm run dev |
Starts the MCP server over stdio. |
npm run dev:http |
Starts the MCP server over local HTTP. |
npm run x:oauth |
Runs the local X OAuth authorization helper. |
npm run build |
Compiles TypeScript to dist. |
npm run start |
Starts the compiled server over stdio. |
npm run start:http |
Starts the compiled server over HTTP. |
npm run typecheck |
Runs TypeScript without emitting files. |
npm test |
Runs the Vitest test suite. |
Documentation
- docs/project-architecture.md: project architecture.
- docs/configuration.md: environment variables and multi-account setup.
- docs/local-server-lifecycle.md: start, stop, and automate the local MCP server.
- docs/tools.md: MCP tools and usage contracts.
- docs/x-oauth.md: X OAuth reauthorization.
- docs/development.md: development, testing, and change guidelines.
- docs/chatgpt-mcp-setup.md: step-by-step ChatGPT MCP setup.
Operational Security
- Keep credentials outside Git.
- Keep
read-onlyas the default mode. - Enable
read-writeonly for controlled workflows. - Verify the active account before publishing.
- Do not log access tokens or refresh tokens.
- Do not paste tokens into chats, issues, docs, or pull requests.
- Do not run automatic startup in
read-writemode on shared computers.
License
No open-source license has been selected yet.
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
E2B
Using MCP to run code via e2b.
Neon Database
MCP server for interacting with Neon Management API and databases
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.