twitterapi-docs-mcp
This MCP server provides AI assistants with fast, offline access to a comprehensive snapshot of TwitterAPI.io documentation, enabling instant lookup without internet connectivity or tab-switching.
Key Capabilities:
Search documentation - Full-text fuzzy search across 54+ API endpoints, guides, and blog posts with camelCase support and typo-tolerance
Get endpoint details - Retrieve complete documentation for specific endpoints including parameters, cURL examples, and code snippets in multiple languages
Browse endpoints by category - List all endpoints organized into 9 categories (User, Tweet, Community, Webhook, Stream, Action, DM, List, Trend)
Access guides - Get conceptual documentation for pricing, rate limits (QPS), authentication, filter rules, changelog, and introduction
Quick pricing lookup - View pricing tiers, credit costs per endpoint, QPS limits by balance level, and cost comparisons
Quick authentication guide - Get API key setup instructions with working code examples in cURL, Python, and JavaScript
Resource URIs - Direct access to specific documentation sections (e.g.,
twitterapi://guides/pricing)
Benefits:
Offline-first operation - Works without network access using bundled documentation
Fast performance - Hybrid caching with memory and disk storage for optimal response times
Integrated workflow - Access documentation directly within AI assistant interfaces
Developer-friendly - Returns markdown-formatted results with code examples ready to use
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-docs-mcp show me the Twitter API rate limits"
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-docs-mcp
This package has been renamed to
twitterapi-io-mcp.twitterapi-docs-mcpis a compatibility wrapper that delegates totwitterapi-io-mcp. It still works, but future updates and support will only be available on the new package.
Migration guide
Switching takes less than a minute. Update the package name in your MCP client config:
Claude Code
# Remove old server and add new one
claude mcp remove twitterapi-docs-mcp
claude mcp add twitterapi-io-mcp -- npx -y twitterapi-io-mcpClaude Desktop
Edit claude_desktop_config.json:
{
"mcpServers": {
// Replace this:
// "twitterapi-docs-mcp": { "command": "npx", "args": ["-y", "twitterapi-docs-mcp"] }
// With this:
"twitterapi-io-mcp": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}Config file location:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.jsonLinux:
~/.config/Claude/claude_desktop_config.json
Cursor
Edit .cursor/mcp.json in your project root (or global config):
{
"mcpServers": {
"twitterapi-io-mcp": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}VS Code (Copilot)
Edit .vscode/mcp.json in your project root:
{
"servers": {
"twitterapi-io-mcp": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}Windsurf
Edit ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"twitterapi-io-mcp": {
"command": "npx",
"args": ["-y", "twitterapi-io-mcp"]
}
}
}Related MCP server: TwitterAPI MCP Server
Why migrate?
Future updates will only be published to
twitterapi-io-mcpDirect support via GitHub Issues
No wrapper overhead - runs the server directly instead of delegating
Legacy usage (still works)
npx -y twitterapi-docs-mcpThis wrapper prints a deprecation notice to stderr and delegates to twitterapi-io-mcp.
Available Tools
6 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: content
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: content
get_twitterapi_guideA
Get TwitterAPI.io guide pages for conceptual topics.
USE THIS WHEN: You need information about pricing, rate limits, authentication, or filter rules. AVAILABLE GUIDES: pricing, qps_limits, tweet_filter_rules, changelog, introduction, authentication, readme
RETURNS: Full guide content with headers, paragraphs, and code examples.
Inputs: guide_name (required). Returns: content
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: content
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: content
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: content
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 6 tools
Each tool has a clearly distinct purpose: get_twitterapi_auth handles authentication setup, get_twitterapi_endpoint provides specific endpoint details, get_twitterapi_guide covers conceptual topics, get_twitterapi_pricing focuses on costs and limits, list_twitterapi_endpoints offers a categorized overview, and search_twitterapi_docs enables cross-documentation search. There is no overlap in functionality, making tool selection straightforward for an agent.
All tool names follow a consistent snake_case pattern with a clear verb_noun structure (e.g., get_twitterapi_auth, list_twitterapi_endpoints, search_twitterapi_docs). The naming is predictable and uniform across all six tools, enhancing readability and usability.
With 6 tools, the server is well-scoped for its purpose of providing documentation access for TwitterAPI.io. Each tool serves a unique and necessary function, from authentication and endpoint details to guides, pricing, listing, and search, covering the domain comprehensively without being overwhelming.
The tool set offers complete coverage for accessing TwitterAPI.io documentation, including authentication, specific endpoints, conceptual guides, pricing, endpoint listings, and search capabilities. There are no obvious gaps; agents can retrieve all necessary information without dead ends, supporting a full range of documentation queries.
Maintenance
Related MCP Connectors
Official twitterapi.io hosted MCP: Twitter/X tweets, users, followers, trends. OAuth or API key.
Hosted MCP server from TwitterAPI.io that gives AI agents read-only access to Twitter/X data. 12 tools: tweet search with X operators, user profiles, a user's latest tweets, followers and followings, replies, quotes, retweeters, mentions and trends. Connect at https://mcp.twitterapi.io/mcp with a TwitterAPI.io API key or account sign-in; usage is paid per result returned.
Hosted X (Twitter) MCP server for Claude, ChatGPT and Cursor, with each action switched per account.
Official MCP server for twitterapis.com. Twitter/X search, users, DMs, Grok, monitoring and writes.
Related MCP Servers
- AlicenseAqualityBmaintenanceOffline-first MCP server for TwitterAPI.io docs (endpoints, pages, blogs) with fast fuzzy search.7656 npm10MIT
- AlicenseBqualityDmaintenanceAn MCP server that provides access to Twitter data and write actions through TwitterAPI.io, bypassing the need for a standard Twitter developer account. It enables users to search tweets, retrieve profiles, and post content with support for pagination and enterprise proxy configurations.5 npmMIT
- AlicenseAqualityCmaintenanceOfficial MCP server for twitterapi.io — Twitter/X data access (search tweets, users, followers, replies, trends) via Claude Desktop, Cursor, VS Code Copilot, or any MCP-compatible client. 12 read-only tools, stdio transport.12112 npm1MIT
- FlicenseNot gradedqualityBmaintenanceRead-only MCP server for public X/Twitter search and retrieval via twitter.2-38.com-