This MCP server provides offline access to TwitterAPI.io documentation for AI assistants, enabling instant lookup of 54 API endpoints, guides, and blog posts without internet access.
Core Capabilities:
Search documentation - Full-text fuzzy search across all endpoints, guides, and blog posts with camelCase/underscore support and typo tolerance
Get endpoint details - Retrieve complete API documentation including HTTP methods, paths, parameters, cURL examples, and code snippets
Browse endpoints by category - List all 54 endpoints organized by 9 categories (user, tweet, community, webhook, stream, action, dm, list, trend)
Access guide pages - Fetch full content of documentation pages like pricing, authentication, QPS limits, filter rules, privacy policy, terms of service, and changelogs
Fetch content by URL - Retrieve content from specific TwitterAPI.io URLs using the offline snapshot with optional live fetching fallback
Get pricing information - Quick access to pricing tiers, credit costs per endpoint, and QPS rate limits
Get authentication guide - Comprehensive authentication setup with API key headers, base URLs, and code examples in cURL, Python, and JavaScript
Key Features:
Offline-first operation with hybrid caching (memory + disk, 24-hour TTL) for optimal performance
Tool chaining support with suggested follow-up actions in search results
Instant retrieval without network latency
Click on "Install 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-mcpsearch 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. 59 endpoints, 19 guides, 21 blog posts. No API key needed.
What is this?
An MCP server that gives Claude, Cursor, VS Code Copilot, and other AI assistants instant, offline access to TwitterAPI.io documentation.
59 API endpoints with parameters, examples, and response schemas
19 guide pages covering pricing, authentication, rate limits, webhooks
21 blog posts with tutorials and use cases
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.
Disclaimer: Independent community project. Not affiliated with TwitterAPI.io.
Installation
Requires: Node.js 18.18.0+
Claude Code (recommended)
Claude Desktop
Add to your config file:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.json
Cursor
Add to .cursor/mcp.json in your project root:
VS Code / VS Code Insiders
Add to .vscode/mcp.json in your project root:
Windsurf
Add to ~/.codeium/windsurf/mcp_config.json:
Docker
Or build from source:
Available 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 resultsCheck the
deprecation_noticefield — some legacy endpoints have v2 replacements
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 endpoints are deprecated?" — triggers
search_twitterapi_docswithquery: "deprecated""How do I upload media and create a tweet?" — triggers sequential
get_twitterapi_endpointcalls
Category | Count | Endpoints |
User | 12 |
|
Tweet | 8 |
|
Community | 9 |
|
Profile | 3 |
|
Webhook | 4 |
|
Stream | 3 |
|
Action | 14 |
|
DM | 2 |
|
List | 2 |
|
Other | 2 |
|
Configuration
Environment Variable | Default | Description |
|
| Set to |
Troubleshooting
npx
The first run downloads the package from npm. If it hangs, try:
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:
claude mcp add
Make sure Claude Code CLI is installed and up to date:
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
Property | 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
Links
npm: twitterapi-io-mcp
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