Twitterapi-io

Provides offline TwitterAPI.io documentation through an MCP server for instant access by AI assistants.

javascript

1

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

You can run the TwitterAPI.io MCP server locally to give AI assistants instant, offline access to comprehensive TwitterAPI.io documentation. This MCP bundles all endpoints, guides, and blog posts, so your AI tools can read and answer questions without network calls or API keys.

How to use

Install and run the MCP server, then connect your AI assistant client (Claude, Cursor, VS Code Copilot, or others) to the local MCP. Your AI applications can search endpoints, fetch full endpoint details, view guides, and retrieve pricing or authentication information from the bundled docs. Use the available tools to look up endpoints, browse guides, or fetch content by URL path.

How to install

Prerequisites: Node.js 18.18.0 or later. Ensure you have npm installed as part of Node.js.

# Install and run the MCP server using the recommended approach
npx -y twitterapi-io-mcp

Additional configuration and usage notes

The MCP server is designed to run locally and does not require an API key. It provides 59 endpoints, 32 guides, and 24 blog posts in an offline snapshot. If you need to customize how you launch the MCP server or integrate with different clients, you can run it via the standard npm script and connect your MCP client to the local process.

If you plan to start the server from a project, you can install dependencies and start with the standard npm workflow.

Troubleshooting

If you encounter issues during first run or with tool discovery, restart your MCP client after adding the server configuration. Ensure you are using Node.js 18.18.0+ and that the MCP command is available in your environment.

Available tools

search_twitterapi_docs

Full-text search across all docs with fuzzy matching to find endpoints, guides, or blog posts by keyword.

get_twitterapi_endpoint

Retrieve complete endpoint documentation including parameters, examples, and response schemas for in-depth understanding.

list_twitterapi_endpoints

List endpoints, optionally filtered by category, to browse available API calls.

get_twitterapi_guide

Fetch guide pages such as pricing, authentication, rate limits, and webhooks.

get_twitterapi_url

Fetch content by a URL path or page key when you have a direct link to docs.

get_twitterapi_pricing

Provide a quick overview of pricing information for the APIs.

get_twitterapi_auth

Offer quick authentication guidance and key usage information.