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.

Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.xquik.com/feedback

{
  "path": "/mcp/overview",
  "feedback": "Description of the issue"
}

Only submit feedback when you have something specific and actionable to report.

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

Setting	Value
Protocol	HTTP (StreamableHTTP)
Endpoint	https://xquik.com/mcp
Auth	API key (x-api-key header) or OAuth 2.1 (Bearer token)

MCP server discovery metadata is available at:

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

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:

Tool	Description	Cost
explore	Search the API spec (read-only, no network calls)	Free
xquik	Execute API calls against your account	Varies by 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. 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.

Aspect	MCP Server	REST API
Best for	AI agents, IDE integrations, natural language workflows	Backend services, automation scripts, programmatic access
Protocol	StreamableHTTP (MCP protocol)	Standard REST (JSON over HTTPS)
Auth	x-api-key header or OAuth 2.1 (Bearer token)	x-api-key header per request
Endpoint	https://xquik.com/mcp	https://xquik.com/api/v1/*
Model	2 tools (explore + xquik) with code-execution sandbox	118 individual endpoints
Unique to REST	-	File download responses (extraction/draw export)
Unique to MCP	AI agent tool descriptions, natural language prompts, server instructions	-

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.

New to MCP? Start with Claude.ai (zero config, OAuth login) or Claude Code (terminal, most flexible).

Setup

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" }
```

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

• "Can you start watching @elonmusk for new tweets and replies?"
• "What accounts am I currently monitoring?"
• "Has anything happened on my monitored accounts today?"
• "Stop tracking @elonmusk, I don't need updates anymore."

Search & Lookup

• "What are people saying about TypeScript on X right now?"
• "Can you find recent tweets from @vercel?"
• "What does this tweet say? https://x.com/elonmusk/status/1893456789012345678"
• "How many likes and retweets does this have? https://x.com/vercel/status/1893704267862470862"

User Profiles & Follows

• "How many followers does @xquikcom have?"
• "What does @openai's bio say?"
• "Does @elonmusk follow @SpaceX back?"
• "Are @vercel and @nextjs following each other?"

Trends

• "What's trending on X right now?"
• "What are the top trending topics in the US?"
• "Is there anything trending about AI today?"

Radar & News

• "What's trending on Hacker News right now?"
• "Show me the top GitHub trending repos today"
• "What are the fastest-growing startups on TrustMRR?"
• "Get me trending topics from Reddit in the last 12 hours"
• "What's popular on Wikipedia right now?"
• "Show me Google Trends for Turkey"
• "Find trending tech news and help me compose a tweet about one"

Extractions

• "Can you pull all the replies to this tweet? https://x.com/elonmusk/status/1893456789012345678"
• "Who retweeted this? https://x.com/vercel/status/1893704267862470862"
• "How much would it cost to extract all followers of @elonmusk?"
• "Get me all the quote tweets on this post: https://x.com/openai/status/1893456789012345678"
• "Can you 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 me the results of my last giveaway draw."

Webhooks

• "Can you set up a webhook at https://my-server.com/events for new tweets?"
• "What webhook endpoints do I have configured?"
• "Remove the webhook pointing to my old server."

Tweet Composition

• "Help me write a tweet about launching my new product"
• "I want it casual and optimized for engagement"
• "Score this draft: Just shipped v2.0 of our API. What do you think?"
• "How can I improve this tweet to get more replies?"

Style Analysis & Drafts

• "Analyze how @elonmusk tweets"
• "Compare @vercel and @nextjs tweeting styles"
• "How are my cached tweets performing?"
• "Save this tweet draft for later"
• "Show me all my 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

• "What plan am I on and how much have I used this month?"
• "Do I have enough budget left to run 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 118 REST API operations.

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