Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt Use this file to discover all available pages before exploring further.

Connect AI Agents via MCP

Connect AI agents to Xquik via the Model Context Protocol

For the complete documentation index, see llms.txt.

Xquik runs a Model Context Protocol server that lets AI agents and development tools interact with your Xquik account programmatically.

Connection

HTTP with StreamableHTTP transport for MCP clients. Connect clients to `https://xquik.com/mcp`. Use an API key in `x-api-key` or OAuth 2.1 Bearer tokens.

MCP server discovery metadata is available at:

https://xquik.com/.well-known/mcp.json

GET and POST requests to /.well-known/mcp.json return the MCP registry server card JSON directly. GET /.well-known/mcp/server-card.json returns the same card for clients that read the nested server-card path. OAuth-aware clients can also read GET /.well-known/oauth-protected-resource/.well-known/mcp.json for protected-resource metadata for https://xquik.com/mcp.

Unauthenticated requests to https://xquik.com/mcp return 401 with a WWW-Authenticate: Bearer challenge. The challenge includes resource_metadata="https://xquik.com/.well-known/oauth-protected-resource/mcp", scope="mcp:tools", error="invalid_token", and error_description="Missing or invalid access token". The JSON body is { "error": "Authentication required" }. OAuth-capable clients use that challenge to discover the authorization metadata. API-key clients should send x-api-key on the first request.

Authentication

The MCP server supports 2 authentication methods:

• API key (x-api-key header): Used by Claude Code, Cursor, VS Code, Windsurf, Codex CLI, OpenCode, and Claude Desktop. Pass your key during the MCP handshake.
• OAuth 2.1 (Bearer token): Used by Claude.ai (web) and ChatGPT Developer Mode. OAuth handles authentication automatically via browser login. No API key needed. See OAuth 2.1 documentation for the complete authorization flow, token lifetimes, and implementation details.

How it works

The MCP server uses a code-execution sandbox model with 2 tools:

Search the API spec. Read-only, no network calls, no credits. Requires MCP authentication to execute. Execute authenticated API calls. Cost follows the endpoint.

The AI agent writes async JavaScript arrow functions that run in a sandboxed environment. Auth is injected automatically.

explore tool

Searches the in-memory API endpoint catalog. Free means no usage credits; the call still requires MCP authentication through an API key or OAuth Bearer token. The sandbox provides:

interface EndpointInfo {
  method: string;
  path: string;
  summary: string;
  category: string; // account, composition, credits, extraction, media, monitoring, support, twitter, x-accounts, x-write
  free: boolean;
  parameters?: Array<{ name: string; in: 'query' | 'path' | 'body'; required: boolean; type: string; description: string }>;
  responseShape?: string;
}

declare const spec: { endpoints: EndpointInfo[] };

xquik tool

Executes API calls. The sandbox provides:

declare const xquik: {
  request(path: string, options?: {
    method?: string;  // default: 'GET'
    body?: unknown;
    query?: Record<string, string>;
  }): Promise<unknown>;
};
declare const spec: { endpoints: EndpointInfo[] };

The agent writes code like async () => xquik.request('/api/v1/radar') and the server executes it with auth injected.

MCP vs REST API

Both the MCP server and REST API connect to the same backend, use the same data, and share the same billing.

Best for AI agents, IDE integrations, and natural language workflows. Connect to `https://xquik.com/mcp` with `x-api-key` or OAuth 2.1 Bearer auth. Agents use 2 tools: `explore` for spec search and `xquik` for sandboxed API calls. Best for backend services, automation scripts, and direct programmatic access. Call `https://xquik.com/api/v1/*` with an `x-api-key` header. Use 120 individual operations and file download responses for extraction or draw exports.

When to use MCP: You're building an AI agent or working in an IDE (Claude Code, Cursor, VS Code, Windsurf) and want the agent to interact with X data through natural language.

When to use REST: You're building a backend service, automation pipeline, or need fine-grained control over API calls, pagination, and file exports.

Start with [Claude.ai](https://claude.ai) for OAuth login or [Claude Code](#setup) for terminal setup.

Setup

Web and terminal clients

Claude.ai supports MCP connectors natively via OAuth. Add Xquik as a connector from **Settings > Feature Preview > Integrations > Add More > Xquik**. The OAuth 2.1 flow handles authentication automatically. No API key needed. Claude Desktop only supports stdio transport. Use the `mcp-remote` npm package as a bridge (requires [Node.js](https://nodejs.org)). Add to your `claude_desktop_config.json`:

```json theme={null}
{
  "mcpServers": {
    "xquik": {
      "command": "npx",
      "args": [
        "mcp-remote@latest",
        "https://xquik.com/mcp",
        "--header",
        "x-api-key:xq_YOUR_KEY_HERE"
      ]
    }
  }
}
```

Add to your `.mcp.json`:

```json theme={null}
{
  "mcpServers": {
    "xquik": {
      "type": "http",
      "url": "https://xquik.com/mcp",
      "headers": {
        "x-api-key": "xq_YOUR_KEY_HERE"
      }
    }
  }
}
```

Add to `~/.codex/config.toml`:

```toml theme={null}
[mcp_servers.xquik]
url = "https://xquik.com/mcp"
http_headers = { "x-api-key" = "xq_YOUR_KEY_HERE" }
```

Editor clients

Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):

```json theme={null}
{
  "mcpServers": {
    "xquik": {
      "url": "https://xquik.com/mcp",
      "headers": {
        "x-api-key": "xq_YOUR_KEY_HERE"
      }
    }
  }
}
```

Add to `.vscode/mcp.json` (project) or use **MCP: Open User Configuration** (global):

```json theme={null}
{
  "servers": {
    "xquik": {
      "type": "http",
      "url": "https://xquik.com/mcp",
      "headers": {
        "x-api-key": "xq_YOUR_KEY_HERE"
      }
    }
  }
}
```

Add to `~/.codeium/windsurf/mcp_config.json`:

```json theme={null}
{
  "mcpServers": {
    "xquik": {
      "serverUrl": "https://xquik.com/mcp",
      "headers": {
        "x-api-key": "xq_YOUR_KEY_HERE"
      }
    }
  }
}
```

Add to `opencode.json`:

```json theme={null}
{
  "mcp": {
    "xquik": {
      "type": "remote",
      "url": "https://xquik.com/mcp",
      "headers": {
        "x-api-key": "xq_YOUR_KEY_HERE"
      }
    }
  }
}
```

ChatGPT

3 ways to connect ChatGPT to Xquik:

Option 1: Custom GPT (Recommended)

Create a Custom GPT and add Xquik as an Action using the OpenAPI schema at https://xquik.com/openapi.json. Set the API key under Authentication > API Key > Header x-api-key.

Option 2: Agents SDK

Use the OpenAI Agents SDK for programmatic access:

from agents.mcp import MCPServerStreamableHttp

async with MCPServerStreamableHttp(
    url="https://xquik.com/mcp",
    headers={"x-api-key": "xq_YOUR_KEY_HERE"},
    params={},
) as xquik:
    # use xquik as a tool provider
    pass

Option 3: Developer Mode

ChatGPT Developer Mode supports MCP connectors via OAuth. Add Xquik from Settings > Developer Mode > MCP Tools > Add. Enter https://xquik.com/mcp as the endpoint. OAuth handles authentication automatically.

Example prompts

Once connected, you can ask your AI agent things like:

Monitoring & Events

• Start watching @elonmusk for new tweets and replies.
• List the accounts I am currently monitoring.
• Show monitored account activity from today.
• Stop tracking @elonmusk.

Search & Lookup

• Search recent X posts about TypeScript.
• Find recent tweets from @vercel.
• Read this tweet: https://x.com/elonmusk/status/1893456789012345678
• Get metrics for this tweet: https://x.com/vercel/status/1893704267862470862

User Profiles & Follows

• Get @xquikcom follower count.
• Read @openai profile bio.
• Check whether @elonmusk follows @SpaceX.
• Check whether @vercel and @nextjs follow each other.

Trends

• Show current X trends.
• Show top trending topics in the US.
• Check whether AI is trending today.

Radar & News

• Show current Hacker News trends.
• Show top GitHub trending repos today.
• Show fastest-growing startup trends.
• Get Reddit trending topics from the last 12 hours.
• Show popular Wikipedia pages right now.
• Show Google Trends for Turkey.
• Find trending tech news and draft a tweet about one item.

Extractions

• Pull all replies to this tweet: https://x.com/elonmusk/status/1893456789012345678
• List users who retweeted this tweet: https://x.com/vercel/status/1893704267862470862
• Estimate the cost to extract all followers of @elonmusk.
• Get quote tweets for this post: https://x.com/openai/status/1893456789012345678
• Extract the full thread for this tweet: https://x.com/elonmusk/status/1893704267862470862

Giveaways

• Pick 3 random winners from this tweet: https://x.com/xquikcom/status/1893456789012345678
• Run a giveaway draw where participants must have retweeted and have at least 100 followers.
• Show the results of my last giveaway draw.

Webhooks

• Set up a webhook at https://my-server.com/events for new tweets.
• List configured webhook endpoints.
• Remove the webhook pointing to my old server.

Tweet Composition

• Write a casual launch tweet for my new product.
• Optimize the draft for engagement.
• Score this draft: Just shipped v2.0 of our API. What do you think?
• Improve this tweet to get more replies.

Style Analysis & Drafts

• Analyze how @elonmusk tweets.
• Compare @vercel and @nextjs tweeting styles.
• Show cached tweet performance.
• Save this tweet draft for later.
• Show all saved drafts.
• Set my X account to @myusername.

X Write Actions

• Post a tweet saying: Just shipped v2.0!
• Like this tweet: https://x.com/vercel/status/1893704267862470862
• Retweet this: https://x.com/openai/status/1893456789012345678
• Follow @vercel from my connected account.
• Send a DM to user ID 44196397 saying hello.
• Upload this image and tweet it with the caption: New feature!

Account & Usage

• Show my plan and month-to-date usage.
• Check whether I have enough budget left for a large extraction.

Framework guides

Build agents with Xquik's MCP tools in your preferred framework:

Python agents with LangChain + LangGraph Multi-agent crews with CrewAI Type-safe agents with Pydantic AI Multi-agent assistants with Google ADK TypeScript agents with Mastra Python agents with Microsoft Agent Framework Replace Composio's deprecated Twitter MCP

AI agent skill

The Xquik Skill gives AI coding agents deep knowledge of the Xquik API without requiring an MCP connection. Install it to let your agent write API integrations, set up webhooks, and configure MCP connections using Xquik best practices.

Works with 40+ AI coding agents including Claude Code, Cursor, GitHub Copilot, Codex, Windsurf, VS Code, Gemini CLI, and more. The skill covers MCP tools and 120 REST API operations.

npx skills add Xquik-dev/x-twitter-scraper