Twitterapi Docs Mcp

io.github.dorukardahanPublished by GitHub account dorukardahanv1.0.3Updated Oct 24, 2026

Offline access to TwitterAPI.io docs for AI assistants. 52 endpoints, guides, pricing.

The publisher's own server: Twitterapi

VerifiedSTDIODesktop onlyKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

Bundled offline snapshot of TwitterAPI.io documentation that lets an assistant search endpoints, guides, pricing and auth details without network calls.

What you can do
  • Search all bundled documentation with fuzzy, typo-tolerant full-text matching
  • Look up a specific API endpoint with its method, parameters, cURL examples and response schema
  • List endpoints, optionally filtered by category such as user, tweet, list or community
  • Read guide pages on pricing, authentication, rate limits, webhooks and streaming
  • Fetch a documentation page by URL path or page key, plus quick pricing and auth summaries
When to use it
Useful when building against TwitterAPI.io or the Twitter/X API and you want the assistant to answer questions about endpoints, parameters, rate limits, pricing or authentication without leaving the editor or opening the docs site.
Requirements
Runs locally over stdio via npx from the npm package; requires Node.js 18.18.0 or later. No API key, account, environment variables or network access are needed for the documentation itself, though the first run downloads the package from npm. An optional environment variable disables the disk cache.
Before you install
Documentation only: it does not call the live TwitterAPI.io API, so it cannot fetch tweets or perform actions. The bundled snapshot can lag behind the live service, and the README notes platform changes such as disabled search operators. It is an independent community project, not affiliated with TwitterAPI.io.

Installation

In SourceWeft

  1. Open Twitterapi Docs Mcp in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

twitterapi-io-mcp

Offline TwitterAPI.io documentation for Claude and AI assistants via MCP. 75 active endpoints (with full method/params/body), 32 guides, 24 blog posts. No API key needed.

[npm version] [npm downloads] [Smithery] [GitHub stars] [License: MIT]

bash
# Quick install (Claude Code)claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp

What is this?

An MCP server that gives Claude, Cursor, VS Code Copilot, and other AI assistants instant, offline access to TwitterAPI.io documentation.

  • 75 active API endpoints with full HTTP method, body/query parameters, cURL examples, and response schemas
  • 32 guide pages covering pricing, authentication, rate limits, webhooks, streaming
  • 24 blog posts with tutorials and use cases
  • All v2 write endpoints documented with login_cookies, proxy, and body params
  • All deprecated v1 endpoints removed — only current v2 endpoints remain
  • Zero API key required — everything is bundled locally

Unlike other Twitter MCP servers that proxy live API calls (and need your API key), this one ships a complete documentation snapshot. Your AI assistant reads it locally, instantly.

Recent Changes

  • v1.2.0: OpenAPI-first scraper rewrite — structured parameters with types, response schemas, eliminates Vercel checkpoint issues
  • v1.1.x: Added list_timeline + get_user_timeline, removed 7 deprecated V1 endpoints, security fixes (hono, ajv, express-rate-limit)
  • v1.0.23: Platform advisory — Twitter disabled since:/until: search operators. Use since_time:UNIX / until_time:UNIX instead
  • v1.0.22: Added 7 endpoints (get_space_detail, get_tweet_replies_v2, get_user_about, etc.)

See CHANGELOG.md for full history.

Disclaimer: Independent community project. Not affiliated with TwitterAPI.io.

Installation

Previously published as twitterapi-docs-mcp? Just change the package name — everything else stays the same.

Requires: Node.js 18.18.0+

Claude Code (recommended)

bash
# Add globally (all projects)claude mcp add --scope user twitterapi-io -- npx -y twitterapi-io-mcp
# Or project-onlyclaude mcp add twitterapi-io -- npx -y twitterapi-io-mcp
# Verifyclaude mcp list

Claude Desktop

Add to your config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json
json
{  "mcpServers": {    "twitterapi-io": {      "command": "npx",      "args": ["-y", "twitterapi-io-mcp"]    }  }}

Cursor

Add to .cursor/mcp.json in your project root:

json
{  "mcpServers": {    "twitterapi-io": {      "command": "npx",      "args": ["-y", "twitterapi-io-mcp"]    }  }}

VS Code / VS Code Insiders

Add to .vscode/mcp.json in your project root:

json
{  "servers": {    "twitterapi-io": {      "command": "npx",      "args": ["-y", "twitterapi-io-mcp"]    }  }}

Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

json
{  "mcpServers": {    "twitterapi-io": {      "command": "npx",      "args": ["-y", "twitterapi-io-mcp"]    }  }}

Docker

bash
docker run -i --rm $(docker build -q .) 2>/dev/null

Or build from source:

bash
git clone https://github.com/dorukardahan/twitterapi-io-mcp.gitcd twitterapi-io-mcp && npm installnode index.js

Available tools

ToolDescriptionBest for
search_twitterapi_docsFull-text search across all docs (fuzzy matching, typo-tolerant)Finding endpoints, guides, or blog posts by keyword
get_twitterapi_endpointGet full endpoint documentation with params, examples, response schemaDeep dive into a specific API endpoint
list_twitterapi_endpointsList endpoints, optionally filtered by categoryBrowsing what's available in a category
get_twitterapi_guideGet guide pages (pricing, auth, rate limits, webhooks, etc.)Understanding platform rules and setup
get_twitterapi_urlFetch content by URL path or page keyWhen you have a direct link to docs
get_twitterapi_pricingQuick pricing overviewCost questions
get_twitterapi_authQuick authentication guideAuth setup and API key usage

For AI assistants

If you're an AI assistant using this MCP server, here's a quick reference:

User wants...Use this toolExample
Find an endpointsearch_twitterapi_docsquery: "advanced search"
Endpoint detailsget_twitterapi_endpointendpoint_name: "tweet_advanced_search"
List all endpointslist_twitterapi_endpointscategory: "user" (optional)
Pricing infoget_twitterapi_pricingNo params needed
Auth guideget_twitterapi_authNo params needed
Any guide/pageget_twitterapi_guideguide_name: "qps_limits"
Fetch by URLget_twitterapi_urlurl: "pricing"

Tips:

  • Search is fuzzy and typo-tolerant: "twet object" still finds results
  • Use max_results: 5 for focused results
  • All endpoints are current v2 — no deprecated endpoints remain

What can you ask?

Here are real prompts that work well with this MCP server:

  • "What are the rate limits for TwitterAPI.io?" — triggers get_twitterapi_guide
  • "Show me the tweet advanced search endpoint" — triggers get_twitterapi_endpoint
  • "How do I authenticate with the API?" — triggers get_twitterapi_auth
  • "What's the pricing?" — triggers get_twitterapi_pricing
  • "List all user-related endpoints" — triggers list_twitterapi_endpoints with category: "user"
  • "How do webhook filter rules work?" — triggers search_twitterapi_docs
  • "What write endpoints need login?" — triggers search_twitterapi_docs with query: "login_cookies"
  • "How do I upload media and create a tweet?" — triggers sequential get_twitterapi_endpoint calls
All 75 endpoints by category
CategoryCountEndpoints
User13get_user_by_username, get_user_about, search_user, batch_get_user_by_userids, get_user_last_tweets, get_user_timeline, get_user_mention, get_user_followers, get_user_verified_followers, get_user_followings, check_follow_relationship, get_my_info, get_user_followers_ids
Other2get_space_detail, bookmarks_v2
Trend1get_trends
Tweet10get_tweet_by_ids, get_article, get_tweet_reply, get_tweet_replies_v2, get_tweet_thread_context, get_tweet_quote, get_tweet_retweeter, tweet_advanced_search, bookmark_tweet_v2, unbookmark_tweet_v2
List6list_timeline, get_list_members, get_list_followers, add_list_member, remove_list_member, get_list_tweets
Community9get_all_community_tweets, create_community_v2, delete_community_v2, join_community_v2, leave_community_v2, get_community_by_id, get_community_members, get_community_moderators, get_community_tweets
Action25user_login_v2, create_tweet_v2, upload_media_v2, like_tweet_v2, unlike_tweet_v2, delete_tweet_v2, retweet_tweet_v2, follow_user_v2, unfollow_user_v2, update_avatar_v2, update_banner_v2, update_profile_v2, login_by_2fa, login_by_email_or_username, upload_image, create_tweet, like_tweet, retweet_tweet, block_user_v2, mute_user_v2, pin_tweet_v2, unblock_user_v2, unmute_user_v2, unpin_tweet_v2, unretweet_tweet_v2
Dm2send_dm_v2, get_dm_history
Webhook4get_webhook_rules, add_webhook_rule, update_webhook_rule, delete_webhook_rule
Stream3add_user_to_monitor_tweet, remove_user_to_monitor_tweet, get_user_to_monitor_tweet

Configuration

Environment VariableDefaultDescription
TWITTERAPI_MCP_DISK_CACHE1 (on)Set to 0 to disable disk caching

Troubleshooting

npx hangs or fails on first run

The first run downloads the package from npm. If it hangs, try:

bash
npx -y twitterapi-io-mcp@latest

Or install globally: npm install -g twitterapi-io-mcp

"Node.js version not supported"

This server requires Node.js 18.18.0 or later. Check your version:

bash
node --version

claude mcp add not recognized

Make sure Claude Code CLI is installed and up to date:

bash
claude --version

Server starts but no tools appear

Restart your MCP client after adding the server config. Most clients (Claude Desktop, Cursor) need a restart to detect new MCP servers.

How it works

┌─────────────┐     MCP (stdio)      ┌──────────────────┐│   Claude /   │ ◄──────────────────► │ twitterapi-io-mcp││  Cursor /    │                      │                  ││  VS Code     │                      │  Bundled docs    │└─────────────┘                      │  (75 endpoints)  │                                     └──────────────────┘                                       No network needed
PropertyValue
RuntimeNode.js 18.18.0+ (ES Modules, no build step)
ProtocolMCP via stdio
CachingHybrid (memory + disk), 24h TTL
SearchN-gram tokenization with fuzzy matching
  1. AI assistant calls an MCP tool (search, get endpoint, etc.)
  2. Server searches the bundled documentation snapshot
  3. Results return instantly with no network requests

Why I built this

I use TwitterAPI.io daily for my projects. Switching between my editor and their docs site got old fast. So I packaged the entire documentation into an MCP server. Now I ask Claude and get answers without leaving my terminal.

If you work with the Twitter/X API through TwitterAPI.io, this saves you the same context-switching. Install it, forget about it, and just ask.

Development

bash
git clone https://github.com/dorukardahan/twitterapi-io-mcp.gitcd twitterapi-io-mcpnpm installnpm test        # Run tests (48 tests)npm start       # Start server locallynpm run scrape  # Update docs snapshot from twitterapi.io

Not using MCP?

If your AI tool doesn't support MCP (like OpenClaw), use the skill version instead — a single markdown file with all 75 active endpoints:

👉 twitterapi-io-skill — works with OpenClaw, Claude, GPT, Gemini, and any LLM.

Links

Contributing

PRs welcome! Fork the repo, create a branch, make your changes, and open a pull request. Bug reports and feature requests go to GitHub Issues.

License

MIT

Acknowledgments

Source: README.md at commit 66c79b1

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v1.0.3LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

Other Twitterapi integrations