# dorukardahan/twitterapi-docs-mcp [Health: Active]

**Category:** 🌐 Social Media  
**Repository:** https://github.com/dorukardahan/twitterapi-docs-mcp  
**GitHub Stars:** 10  
**npm Downloads (last month):** 1084  
**Views:** 5  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/dorukardahan-twitterapi-docs-mcp

## Description
Offline access to TwitterAPI.io documentation for AI assistants. 52 API endpoints, guides, pricing info, and authentication docs.

## Tools
Capabilities this server exposes over MCP:

- **search_twitterapi_docs** — 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)
- **get_twitterapi_endpoint** — 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
- **list_twitterapi_endpoints** — 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.
- **get_twitterapi_guide** — 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.
- **get_twitterapi_url** — 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).
- **get_twitterapi_pricing** — 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.
- **get_twitterapi_auth** — 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.

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `npx` (confidence: high):

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

## Documentation

## What dorukardahan/twitterapi-docs-mcp does

dorukardahan/twitterapi-docs-mcp exposes TwitterAPI.io reference material as MCP tools for AI assistants. The package includes documentation for current v2 endpoints, guide pages, and blog content in an offline snapshot, so assistants can inspect API behavior without proxying requests to TwitterAPI.io or requiring an API key for the documentation server.

The snapshot covers endpoint methods, request parameters, request bodies, response schemas, cURL examples, and code snippets. It also includes material on authentication, pricing, credit usage, QPS limits, webhooks, streaming, and related platform rules. Deprecated v1 endpoints are excluded from the documented endpoint set.

## How it works

The server communicates over the standard local process pattern used by MCP clients. Running the package with `npx` starts the server and makes its bundled content available to the connected assistant. Documentation queries are handled against the local snapshot.

Search uses fuzzy, typo-tolerant matching across endpoint documentation, guides, and blog posts. Results can be narrowed with a maximum-result setting. When a direct documentation link is available, the URL tool can resolve it from the snapshot; live fetching can be enabled only for TwitterAPI.io and docs.twitterapi.io URLs.

## Setup and configuration

Node.js 18.18.0 or newer is required. No TwitterAPI.io API key is needed to run the documentation server.

For Claude Code, add the package with:

```bash
claude mcp add --scope user twitterapi-io -- npx -y twitterapi-io-mcp
```

Claude Desktop, Cursor, VS Code, and Windsurf can use an MCP configuration that runs `npx` with `-y twitterapi-io-mcp` as its arguments. The package can also be built from source with `npm install` and started with `node index.js`, or run through Docker using the repository's Docker setup.

Disk caching is enabled by default. Set `TWITTERAPI_MCP_DISK_CACHE=0` to disable it.

## Tools and capabilities

- `search_twitterapi_docs` searches the full documentation corpus and returns ranked matches with endpoint paths, descriptions, and relevance scores.
- `get_twitterapi_endpoint` returns detailed information for a named endpoint, including parameters, paths, examples, and response schemas.
- `list_twitterapi_endpoints` lists endpoints by category, including user, tweet, community, webhook, stream, action, DM, list, and trend groups.
- `get_twitterapi_guide` retrieves a guide or documentation page by its page key.
- `get_twitterapi_url` resolves a TwitterAPI.io documentation URL or path from the offline snapshot, with restricted live fetching available.
- `get_twitterapi_pricing` provides credit costs, pricing tiers, and QPS limits.
- `get_twitterapi_auth` returns the API-key header format and authentication examples for cURL, Python, and JavaScript.

## Limitations and notes

This package provides documentation rather than a general-purpose TwitterAPI.io request proxy. Its bundled content can become separate from changes made to the upstream API until the package snapshot is updated. Live URL retrieval is restricted to TwitterAPI.io and docs.twitterapi.io domains. The project is an independent community implementation and is not affiliated with TwitterAPI.io.

_Full upstream README: https://allmcps.com/mcp/dorukardahan-twitterapi-docs-mcp/readme_