twitterapi-docs-mcp
MCP (Model Context Protocol) server providing offline access to TwitterAPI.io documentation for Claude and other AI assistants.
Disclaimer: This is an unofficial community project. Not affiliated with, endorsed by, or sponsored by TwitterAPI.io. TwitterAPI.io is a trademark of its respective owner.
Why I Built This
I'm an independent developer who uses TwitterAPI.io for my projects. I found myself constantly switching between my code editor and the documentation website, searching for endpoint details, checking rate limits, and looking up authentication requirements.
So I built this MCP server to have instant access to the entire documentation right inside Claude. No more tab-switching, no more searching — just ask Claude and get the answer.
I'm sharing this with the community because if it helped me, it might help you too. 🚀
Features
52 API endpoints documented
8 guide pages (pricing, QPS limits, filter rules, changelog, etc.)
5 blog articles (pricing comparison, analytics guide, etc.)
Offline-first - Works without network access
Fast search with fuzzy matching and camelCase support
Hybrid caching for optimal performance
Installation
Claude Desktop
Add to your Claude Desktop configuration file:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Claude Code
Verify installation:
Available Tools
Tool | Description |
| Full-text search across all docs (endpoints, guides, blogs) |
| Get detailed info for a specific API endpoint |
| List all endpoints with optional category filter |
| Get guide pages (pricing, qps_limits, authentication, etc.) |
| Quick access to pricing information |
| Quick access to authentication guide |
Available Resources
Resource URI | Description |
| Pricing guide |
| QPS limits and rate limiting |
| Tweet filter rules syntax |
| API changelog |
| Introduction to TwitterAPI.io |
| Authentication guide |
| Full endpoint listing |
| Data freshness status |
Usage Examples
Once installed, you can ask Claude questions like:
"What are the QPS limits for TwitterAPI.io?"
"Show me the advanced search endpoint"
"How do webhook filter rules work?"
"How do I get user followers?"
"What's the pricing structure?"
"How do I authenticate with the API?"
API Endpoint Categories
Category | Count | Examples |
User | 9 | get_user_by_username, get_user_followers, get_user_followings |
Tweet | 7 | tweet_advanced_search, get_tweet_reply, get_tweet_quote |
Community | 5 | get_community_by_id, get_community_members |
Webhook | 4 | add_webhook_rule, get_webhook_rules |
Stream | 2 | add_user_to_monitor_tweet |
Action | 16 | create_tweet, like_tweet, follow_user_v2 |
DM | 2 | send_dm_v2, get_dm_history_by_user_id |
List | 2 | get_list_followers, get_list_members |
Trend | 1 | get_trends |
How It Works
This MCP server bundles a snapshot of TwitterAPI.io documentation (scraped with permission patterns). When Claude or another MCP-compatible AI assistant needs information about TwitterAPI.io:
The assistant calls one of the available tools
The server searches/retrieves from the local documentation cache
Results are returned instantly without network latency
The documentation includes:
Complete API reference with request/response examples
Authentication guides
Rate limiting information
Pricing details
Best practices
Updating Documentation
If TwitterAPI.io updates their documentation, clone the repo and run the scraper:
Note: The scraper is included in the repository but not in the npm package.
Development
Technical Details
Runtime: Node.js 18.18.0+
Module System: ES Modules (no build step)
Protocol: MCP (Model Context Protocol) via stdio
Caching: Hybrid (memory + disk) with 24-hour TTL
Search: Advanced tokenization with n-gram fuzzy matching
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Fork the repository
Create your feature branch (
git checkout -b feature/amazing-feature)Commit your changes (
git commit -m 'Add amazing feature')Push to the branch (
git push origin feature/amazing-feature)Open a Pull Request
License
MIT - see LICENSE file for details.
Acknowledgments
TwitterAPI.io for providing excellent Twitter/X API access
Anthropic for the Model Context Protocol
MCP SDK for the server framework