twitterapi-io-mcp
An offline MCP documentation server for TwitterAPI.io that helps AI assistants explore API endpoints, guides, blog posts, pricing, and authentication without an API key.
Search all bundled docs with fuzzy matching across endpoints, guides, and blog posts.
Retrieve full documentation for a specific endpoint, including parameters, cURL examples, and response details.
List available API endpoints, optionally filtered by category.
Fetch full guide/page content such as rate limits, webhooks, privacy, and filter rules.
Fetch documentation by URL path, with optional live fetch fallback for allowed hosts.
Get quick pricing, credit cost, and QPS limit information.
Get authentication setup details, base URL, and request examples.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@twitterapi-io-mcp search for rate limit information"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
twitterapi-io-mcp
Offline TwitterAPI.io documentation for Claude and AI assistants via MCP. 76 active endpoints (with full method/params/body), 32 guides, 24 blog posts. No API key needed.
# Quick install (Claude Code)
claude mcp add twitterapi-io -- npx -y twitterapi-io-mcpWhat is this?
An MCP server that gives Claude, Cursor, VS Code Copilot, and other AI assistants instant, offline access to TwitterAPI.io documentation.
76 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 paramsAll 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. Usesince_time:UNIX/until_time:UNIXinsteadv1.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.
Related MCP server: mcp-server-markdown
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)
# Add globally (all projects)
claude mcp add --scope user twitterapi-io -- npx -y twitterapi-io-mcp
# Or project-only
claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp
# Verify
claude mcp listClaude Desktop
Add to your config file:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.jsonLinux:
~/.config/Claude/claude_desktop_config.json
{
"mcpServers": {
"twitterapi-io": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}Cursor
Add to .cursor/mcp.json in your project root:
{
"mcpServers": {
"twitterapi-io": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}VS Code / VS Code Insiders
Add to .vscode/mcp.json in your project root:
{
"servers": {
"twitterapi-io": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}Windsurf
Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"twitterapi-io": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}Docker
docker run -i --rm $(docker build -q .) 2>/dev/nullOr build from source:
git clone https://github.com/dorukardahan/twitterapi-io-mcp.git
cd twitterapi-io-mcp && npm install
node index.jsAvailable tools
Tool | Description | Best for |
| Full-text search across all docs (fuzzy matching, typo-tolerant) | Finding endpoints, guides, or blog posts by keyword |
| Get full endpoint documentation with params, examples, response schema | Deep dive into a specific API endpoint |
| List endpoints, optionally filtered by category | Browsing what's available in a category |
| Get guide pages (pricing, auth, rate limits, webhooks, etc.) | Understanding platform rules and setup |
| Fetch content by URL path or page key | When you have a direct link to docs |
| Quick pricing overview | Cost questions |
| Quick authentication guide | Auth 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 tool | Example |
Find an endpoint |
|
|
Endpoint details |
|
|
List all endpoints |
|
|
Pricing info |
| No params needed |
Auth guide |
| No params needed |
Any guide/page |
|
|
Fetch by URL |
|
|
Tips:
Search is fuzzy and typo-tolerant:
"twet object"still finds resultsUse
max_results: 5for focused resultsAll 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_endpointswithcategory: "user""How do webhook filter rules work?" — triggers
search_twitterapi_docs"What write endpoints need login?" — triggers
search_twitterapi_docswithquery: "login_cookies""How do I upload media and create a tweet?" — triggers sequential
get_twitterapi_endpointcalls
Category | Count | Endpoints |
User | 14 |
|
Other | 2 |
|
Trend | 1 |
|
Tweet | 10 |
|
List | 6 |
|
Community | 9 |
|
Action | 25 |
|
Dm | 2 |
|
Webhook | 4 |
|
Stream | 3 |
|
Configuration
Environment Variable | Default | Description |
|
| Set to |
Troubleshooting
npx hangs or fails on first run
The first run downloads the package from npm. If it hangs, try:
npx -y twitterapi-io-mcp@latestOr 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:
node --versionclaude mcp add not recognized
Make sure Claude Code CLI is installed and up to date:
claude --versionServer 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 │
└─────────────┘ │ (76 endpoints) │
└──────────────────┘
No network neededProperty | Value |
Runtime | Node.js 18.18.0+ (ES Modules, no build step) |
Protocol | MCP via stdio |
Caching | Hybrid (memory + disk), 24h TTL |
Search | N-gram tokenization with fuzzy matching |
AI assistant calls an MCP tool (search, get endpoint, etc.)
Server searches the bundled documentation snapshot
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
git clone https://github.com/dorukardahan/twitterapi-io-mcp.git
cd twitterapi-io-mcp
npm install
npm test # Run tests (48 tests)
npm start # Start server locally
npm run scrape # Update docs snapshot from twitterapi.ioNot using MCP?
If your AI tool doesn't support MCP (like OpenClaw), use the skill version instead — a single markdown file with all 76 active endpoints:
👉 twitterapi-io-skill — works with OpenClaw, Claude, GPT, Gemini, and any LLM.
Links
npm: twitterapi-io-mcp
Skill version: dorukardahan/twitterapi-io-skill
GitHub: dorukardahan/twitterapi-io-mcp
MCP Registry: registry.modelcontextprotocol.io
TwitterAPI.io: twitterapi.io
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
Acknowledgments
TwitterAPI.io for the API service
Anthropic for the Model Context Protocol
Available Tools
7 toolsget_twitterapi_authA
Get TwitterAPI.io authentication guide: API key usage, headers, code examples.
USE THIS WHEN: You need to set up authentication or see request examples. RETURNS: API key header format, base URL, cURL/Python/JavaScript examples.
Inputs: no named parameters. Returns: header, base_url, examples, markdown, +1 more
get_twitterapi_endpointA
Get complete documentation for a specific TwitterAPI.io endpoint.
USE THIS WHEN: You know the exact endpoint name (e.g., from search results). RETURNS: Full details including path, parameters, cURL example, and code snippets.
Common endpoints:
get_user_info, get_user_followers, get_user_following
tweet_advanced_search, get_tweet_by_id
add_webhook_rule, get_webhook_rules
Inputs: endpoint_name (required). Returns: path, title, cached, method, +9 more
get_twitterapi_guideA
Get a TwitterAPI.io page from the offline snapshot by page key.
USE THIS WHEN: You need the full content of a specific page (guides, docs, policies, contact, etc.). TIP: Use search_twitterapi_docs if you don't know the page key.
RETURNS: Full guide content with headers, paragraphs, and code examples.
Inputs: guide_name (required). Returns: url, title, headers, markdown, +6 more
get_twitterapi_pricingA
Get TwitterAPI.io pricing information: credit system, endpoint costs, QPS limits.
USE THIS WHEN: You need to know API costs, credit calculations, or rate limits. RETURNS: Pricing tiers, credit costs per endpoint, QPS limits by balance level.
Inputs: no named parameters. Returns: costs, notes, markdown, qps_limits, +2 more
get_twitterapi_urlA
Fetch a TwitterAPI.io or docs.twitterapi.io URL.
USE THIS WHEN: You have a specific link and want its full content. RETURNS: Parsed content from the offline snapshot. If not found, you can set fetch_live=true (restricted to twitterapi.io/docs.twitterapi.io).
Inputs: url (required), fetch_live. Returns: url, kind, name, title, +3 more
list_twitterapi_endpointsA
List all TwitterAPI.io API endpoints organized by category.
USE THIS WHEN: You need to browse available endpoints or find endpoints by category. CATEGORIES: user, tweet, community, webhook, stream, action, dm, list, trend
RETURNS: Endpoint names with HTTP method and path for each category.
Inputs: category. Returns: total, category, markdown, endpoints, +1 more
search_twitterapi_docsA
Search TwitterAPI.io documentation: API endpoints, guides (pricing, rate limits, filter rules), and blog posts.
USE THIS WHEN: You need to find information across the entire documentation. RETURNS: Ranked results with endpoint paths, descriptions, and relevance scores.
Examples:
"advanced search" → finds tweet search endpoints
"rate limit" → finds QPS limits and pricing info
"webhook" → finds webhook setup endpoints
"getUserInfo" → finds user info endpoints (supports camelCase)
Inputs: query (required), max_results. Returns: query, cached, counts, results, +2 more
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 7 tools
Each tool has a clearly distinct purpose: authentication, specific endpoint docs, page content, pricing, URL fetching, listing endpoints, and searching docs. No overlap in functionality.
All tool names follow a consistent verb_noun pattern with underscore (get_, list_, search_) and include 'twitterapi' for context. No mixing of conventions.
7 tools is well-scoped for a documentation-focused server. Each tool provides a necessary function without redundancy, and the count is appropriate for the domain.
The tool set covers core documentation needs: auth, endpoint details, pricing, search, and listing. Minor gaps like error codes or changelog, but the surface is largely complete.
Maintenance
Related MCP Connectors
Unofficial MCP server for the Ionic Framework documentation, components and blog.
MCP server for accessing curated awesome list documentation
Read-only MCP server for the OrchestKit docs: full-text search + Markdown fetch. No auth.
Official MCP server for twitterapis.com. Twitter/X search, users, DMs, Grok, monitoring and writes.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceAn MCP server that provides version-pinned, deterministic documentation sourced from DevDocs.io to AI assistants (Claude, RooCode, Cline, Copilot etc.) and also via offline mode. Not via Scraping! But using the supported downloading option from devdocs.79 npm13MIT
- AlicenseAqualityBmaintenanceMCP server for markdown files — search, extract sections, list headings, find code blocks across docs.6111 npm8MIT
- AlicenseNot gradedqualityBmaintenanceA generic, configurable MCP server that makes any MkDocs documentation site searchable and explorable from MCP clients.1MIT
- FlicenseNot gradedqualityDmaintenanceMCP server to search and read documentation pages from a WikiJS instance via its GraphQL API.-