Skip to main content
Glama
dorukardahan

twitterapi-io-mcp

by dorukardahan
OverviewSchemaRelated ServersScoreDiscussions
JavaScript

twitterapi-io-mcp

npm packages

  • twitterapi-io-mcp (recommended, canonical)

  • twitterapi-docs-mcp (deprecated compatibility wrapper → delegates to twitterapi-io-mcp)

npm version npm downloads npm version (legacy) MCP Registry License: MIT Node.js

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.

Links

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

  • 54 API endpoints documented

  • Site + docs pages via sitemap + internal link crawl (pricing, QPS limits, privacy, contact, terms, acceptable use, dashboard, etc.)

  • Blog posts via blog index crawl (and internal discovery)

  • Offline-first - Works without network access

  • Fast search with fuzzy matching and camelCase support

  • Hybrid caching for optimal performance

Installation

Prerequisites

  • Node.js >=18.18.0 (required to run the MCP server)

  • Claude Code users: the claude CLI installed (for claude mcp add)

Note: This MCP server serves an offline docs snapshot. You do not need a TwitterAPI.io key just to use the docs tools.

Claude Desktop

Requires Node.js >=18.18.0 (because this runs via npx).

Add to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

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

Claude Code

Requires Node.js >=18.18.0 (because this runs via npx).

# Add globally (all projects) claude mcp add --scope user twitterapi-io -- npx -y twitterapi-io-mcp # Or add to current project only claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp # Legacy name (still works, but deprecated) claude mcp add --scope user twitterapi-docs -- npx -y twitterapi-docs-mcp

Verify installation:

claude mcp list

Troubleshooting:

  • claude: command not found → install Claude Code / the claude CLI first

  • npx fails or shows syntax errors → upgrade Node.js to >=18.18.0

  • Corporate networks → ensure npm can reach the registry (or configure your proxy/registry)

  • Quick preflight: node -v and claude --version should both work before running claude mcp add

Optional Configuration

  • TWITTERAPI_MCP_DISK_CACHE=0 disables disk cache across sessions (default: on). TTL cleanup runs hourly.

Available Tools

Tool

Description

search_twitterapi_docs

Full-text search across all docs (endpoints, guides, blogs)

get_twitterapi_endpoint

Get detailed info for a specific API endpoint

list_twitterapi_endpoints

List all endpoints with optional category filter

get_twitterapi_guide

Get a page by key (guides + other site/docs pages)

get_twitterapi_url

Fetch by URL, bare path (pricing), or page key (qps_limits) (snapshot, optional live fetch)

get_twitterapi_pricing

Quick access to pricing information

get_twitterapi_auth

Quick access to authentication guide

Available Resources

Note: resources are optional. The canonical guide fetch is get_twitterapi_guide (e.g., guide_name: "changelog").

Resource URI

Description

twitterapi://guides/pricing

Pricing guide

twitterapi://guides/qps-limits

QPS limits and rate limiting

twitterapi://guides/filter-rules

Tweet filter rules syntax

twitterapi://guides/introduction

Introduction to TwitterAPI.io

twitterapi://guides/authentication

Authentication guide

twitterapi://endpoints/list

Full endpoint listing

twitterapi://status/freshness

Data freshness status

MCP Tool Recipes

If you’re evaluating this MCP via Context7 or want copy/pasteable “tool chaining” patterns, see CONTEXT7.md.

Focused, single-purpose recipes are in recipes/ (e.g. recipes/01-auth-summary.md, recipes/07-rate-limits.md).

Common workflows:

  • Rate limits: search_twitterapi_docs ("rate limit qps") → get_twitterapi_guide ("qps_limits")

  • Typos are OK: search_twitterapi_docs is fuzzy/typo-tolerant (e.g., "twet object")

  • Tweets Lookup: get_twitterapi_endpoint ("get_tweet_by_ids")

Context7 Quick Recipes (copy/paste)

Search → refine → endpoint details (Q2)

{ "tool": "search_twitterapi_docs", "arguments": { "query": "advanced search", "max_results": 10 } }

Filter to type: "endpoint" results. If none, retry with a narrower query like "advanced search endpoint". Then fetch details using the returned name:

{ "tool": "get_twitterapi_endpoint", "arguments": { "endpoint_name": "tweet_advanced_search" } }

Ambiguity handling (if multiple endpoints are close in score):

{ "tool": "search_twitterapi_docs", "arguments": { "query": "advanced search GET /twitter/tweet/advanced_search", "max_results": 10 } }

Then pick the top type: "endpoint" result and call get_twitterapi_endpoint with its name.

Routing tips (dynamic refinement):

  • If a result includes next, you can directly call next.tool with next.arguments.

  • If you get only page/blog results, route to get_twitterapi_guide or get_twitterapi_url instead of get_twitterapi_endpoint.

Changelogs via get_twitterapi_guide (Q7)

{ "tool": "get_twitterapi_guide", "arguments": { "guide_name": "changelog" } }

Do not use resources/read for this question; the canonical tool is get_twitterapi_guide.

Tweets Lookup endpoint details (Q9)

Tweets Lookup maps to endpoint_name: "get_tweet_by_ids".

{ "tool": "get_twitterapi_endpoint", "arguments": { "endpoint_name": "get_tweet_by_ids" } }

Auth metadata (Q1)

{ "tool": "get_twitterapi_auth", "arguments": {} }

Endpoint details also include an auth block (header/base URL). For per-endpoint extras, scan description/parameters for login_cookie or proxy.

Authentication page snapshot (Q6)

{ "tool": "get_twitterapi_url", "arguments": { "url": "/documentation/authentication" } }

Fallback if the snapshot is missing:

{ "tool": "get_twitterapi_guide", "arguments": { "guide_name": "authentication" } }

Pagination search (Q5)

{ "tool": "search_twitterapi_docs", "arguments": { "query": "pagination cursor next_cursor", "max_results": 10 } }

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

11

get_user_by_username, get_user_followers, batch_get_user_by_userids

Tweet

7

tweet_advanced_search, get_tweet_by_ids, get_tweet_quote

Community

9

create_community_v2, get_community_by_id, join_community_v2

Webhook

4

add_webhook_rule, get_webhook_rules

Stream

2

add_user_to_monitor_tweet, remove_user_to_monitor_tweet

Action

15

create_tweet_v2, like_tweet_v2, upload_media_v2

DM

2

send_dm_v2, get_dm_history_by_user_id

List

2

get_list_followers, get_list_members

Trend

1

get_trends

Other

1

get_space_detail

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:

  1. The assistant calls one of the available tools

  2. The server searches/retrieves from the local documentation cache

  3. 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:

git clone https://github.com/dorukardahan/twitterapi-io-mcp.git cd twitterapi-io-mcp npm install node scrape-all.cjs

Note: The scraper is included in the repository but not in the npm package.

Development

# Clone repository git clone https://github.com/dorukardahan/twitterapi-io-mcp.git cd twitterapi-io-mcp # Install dependencies npm install # Run tests npm test # Start server locally npm start

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.

  1. Fork the repository

  2. Create your feature branch (git checkout -b feature/amazing-feature)

  3. Commit your changes (git commit -m 'Add amazing feature')

  4. Push to the branch (git push origin feature/amazing-feature)

  5. Open a Pull Request

License

MIT - see LICENSE file for details.

Acknowledgments

Install Server
A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

How are these scores calculated?

Resources

Tools

New MCP Servers

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dorukardahan/twitterapi-io-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server