> ## 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.

# Docs MCP server

> Search public Xquik documentation from AI tools through the Docs MCP server

<blockquote className="agent-llms-directive">
  For the complete documentation index, see <a href="/llms.txt">llms.txt</a>.
</blockquote>

Xquik documentation is available as an MCP server at `https://docs.xquik.com/mcp`. AI tools can search the full docs site and retrieve indexed public pages - API reference, guides, examples, and type definitions - during conversations.

This is separate from the [Xquik API MCP server](/mcp/overview) at `xquik.com/mcp`, which interacts with your Xquik account (monitors, extractions, draws, X data lookups). The docs MCP server is read-only and requires no authentication.

<CardGroup cols={2}>
  <Card title="Docs MCP Server" icon="book-open">
    Search docs and read indexed public pages at `https://docs.xquik.com/mcp`. No auth required. Free.
  </Card>

  <Card title="API MCP Server" icon="terminal">
    Interact with X data at `https://xquik.com/mcp`. Use an API key or OAuth 2.1.
    Prefer OAuth for clients that support browser authorization.
    Full credentials search 118 operations. Guest `paid_reads` keys search 33
    eligible GET routes. API MCP v2.5.3 uses Streamable HTTP.
  </Card>
</CardGroup>

## Agent route checklist

<CardGroup cols={2}>
  <Card title="Read docs first" icon="book-open">
    Use Docs MCP at `https://docs.xquik.com/mcp` for public docs, API
    parameters, examples, error codes, SDK guidance, and no-auth page
    retrieval.
  </Card>

  <Card title="Run account actions" icon="terminal">
    Use API MCP at `https://xquik.com/mcp` for live X reads, writes, monitors,
    webhooks, draws, or extraction jobs. Authenticate with an API key or OAuth
    2.1. Prefer OAuth when the client supports browser authorization.
  </Card>

  <Card title="Persist outside chat" icon="boxes">
    Use REST or generated SDKs when a backend must own retries, cursor storage,
    file downloads, queues, or batch orchestration.
  </Card>

  <Card title="Hand off results" icon="file-json">
    Store the endpoint path, request parameters, returned IDs, `has_more`,
    `next_cursor`, export route, or webhook replay route before ending the
    agent run.
  </Card>
</CardGroup>

## Quick connect

Use the contextual menu at the top of any docs page to connect instantly:

* **Copy MCP Server URL** - copies `https://docs.xquik.com/mcp` to your clipboard
* **Copy MCP Install Command** - copies the `npx add-mcp` install command
* **Connect to Cursor** - installs the docs MCP server in Cursor
* **Connect to VS Code** - installs the docs MCP server in VS Code

## Setup

<Tabs>
  <Tab title="Claude.ai (Web)">
    1. Go to [Settings > Connectors](https://claude.ai/settings/connectors) in Claude.
    2. Select **Add custom connector**.
    3. Enter:
       * Name: `Xquik Docs`
       * URL: `https://docs.xquik.com/mcp`
    4. Select **Add**.
    5. In any chat, click the attachments button (plus icon) and select **Xquik Docs**.
  </Tab>

  <Tab title="Claude Code">
    ```bash theme={null}
    claude mcp add --transport http xquik-docs https://docs.xquik.com/mcp
    ```

    Verify with:

    ```bash theme={null}
    claude mcp list
    ```
  </Tab>

  <Tab title="Codex">
    ```bash theme={null}
    codex mcp add xquik-docs --url https://docs.xquik.com/mcp
    codex mcp list
    ```
  </Tab>

  <Tab title="Cursor">
    Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):

    ```json theme={null}
    {
      "mcpServers": {
        "xquik-docs": {
          "url": "https://docs.xquik.com/mcp"
        }
      }
    }
    ```
  </Tab>

  <Tab title="VS Code">
    Add to `.vscode/mcp.json` (project) or use **MCP: Open User Configuration** (global):

    ```json theme={null}
    {
      "servers": {
        "xquik-docs": {
          "type": "http",
          "url": "https://docs.xquik.com/mcp"
        }
      }
    }
    ```
  </Tab>

  <Tab title="Windsurf">
    Add to `~/.codeium/windsurf/mcp_config.json`:

    ```json theme={null}
    {
      "mcpServers": {
        "xquik-docs": {
          "serverUrl": "https://docs.xquik.com/mcp"
        }
      }
    }
    ```
  </Tab>

  <Tab title="OpenCode">
    Add to `opencode.json`:

    ```json theme={null}
    {
      "mcp": {
        "xquik-docs": {
          "type": "remote",
          "url": "https://docs.xquik.com/mcp"
        }
      }
    }
    ```
  </Tab>

  <Tab title="Gemini CLI">
    Add to Gemini CLI settings:

    ```json theme={null}
    {
      "mcpServers": {
        "xquik-docs": {
          "httpUrl": "https://docs.xquik.com/mcp"
        }
      }
    }
    ```
  </Tab>
</Tabs>

## Using both MCP servers

For the best experience, connect both:

1. **Docs MCP** (`docs.xquik.com/mcp`) - the AI searches documentation to understand API parameters, error codes, and usage patterns.
2. **API MCP** (`xquik.com/mcp`) - the AI executes actions: searches tweets, runs extractions, sets up monitors.

The AI decides which server to query based on context. A question about how draw filters work hits the docs server. A request to run a draw hits the API server.

API MCP results use the normalized v1 contract: snake\_case fields, date-time fields as Unix seconds, structured errors, `has_more`, and `next_cursor`. Docs MCP returns indexed documentation text and never executes account actions.

<Tabs>
  <Tab title="Claude Code">
    ```bash theme={null}
    claude mcp add --transport http xquik-docs https://docs.xquik.com/mcp
    claude mcp add --transport http xquik https://xquik.com/mcp
    ```

    Run `/mcp` and authenticate `xquik`. The docs server needs no login.
  </Tab>

  <Tab title="Codex">
    ```bash theme={null}
    codex mcp add xquik-docs --url https://docs.xquik.com/mcp
    codex mcp add xquik --url https://xquik.com/mcp
    codex mcp login xquik
    ```
  </Tab>

  <Tab title="Cursor">
    ```json theme={null}
    {
      "mcpServers": {
        "xquik-docs": {
          "url": "https://docs.xquik.com/mcp"
        },
        "xquik": {
          "url": "https://xquik.com/mcp"
        }
      }
    }
    ```
  </Tab>

  <Tab title="VS Code">
    ```json theme={null}
    {
      "servers": {
        "xquik-docs": {
          "type": "http",
          "url": "https://docs.xquik.com/mcp"
        },
        "xquik": {
          "type": "http",
          "url": "https://xquik.com/mcp"
        }
      }
    }
    ```
  </Tab>
</Tabs>

## What gets searched

The docs MCP server indexes all public pages:

* API reference (126 documented operations)
* Guides (workflows, error handling, rate limits, billing, extraction workflow, trends, webhook testing)
* Webhook documentation (overview, signature verification)
* MCP server setup and tools reference
* OAuth 2.1 documentation
* Architecture, troubleshooting, and type definitions
* `llms.txt` (complete API technical reference)