> ## 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 for tweet, follower & webhook docs

> Search Xquik tweet, follower, profile, monitor, webhook, extraction, SDK, MCP, and account-action documentation from AI tools. Includes OAuth and tool examples.

<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 during conversations. Those pages include API reference, guides, examples, and type definitions.

This differs from the [Xquik API MCP server](/mcp/overview) at `xquik.com/mcp`. That server searches tweets, looks up profiles, exports followers, runs draws, and manages monitors. The docs MCP server is read-only and requires no authentication.

## 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="Store 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="braces">
    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:

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

## Search docs through NLWeb

`GET` or `POST https://xquik.com/ask` searches public docs through NLWeb 0.55.
It needs no authentication. Never send secrets or private data.

```bash theme={null}
curl 'https://xquik.com/ask?query=How%20does%20MCP%20OAuth%20work%3F'
```

Send JSON, form data, or query parameters. Structured 0.54 requests remain compatible.
JSON uses `conversational_search` and lowercase response types. Set `prefer.streaming` to `true` for SSE.
Streams emit `start`, `result`, and `complete` events.

## Search docs through A2A

The public [A2A 1.0](https://a2a-protocol.org/latest/specification/) agent card
lives at `https://xquik.com/.well-known/agent-card.json`. It advertises the
JSON-RPC endpoint at `https://xquik.com/a2a`.

Send a `SendMessage` request with `A2A-Version: 1.0`. The agent accepts text
questions and returns the same public documentation results as NLWeb. It needs
no authentication and cannot run extractions or account actions. The server does
not advertise streaming, push notifications, or extended cards.

## Setup

### Web clients

<Tabs>
  <Tab title="Claude.ai (web)">
    1. Open [Claude Connectors](https://claude.ai/settings/connectors) or **Customize > Connectors**.
    2. Select **Add custom connector**.
    3. Enter:
       * Name: `Xquik Docs`
       * URL: `https://docs.xquik.com/mcp`
    4. Select **Add**.
    5. In a chat, select **+ > Connectors** and enable **Xquik Docs**.
  </Tab>

  <Tab title="ChatGPT">
    1. In ChatGPT on the web, open **Settings > Security and login**. Enable **Developer mode**.
    2. Open [**Settings > Plugins**](https://chatgpt.com/plugins). Select **+**.
    3. Enter `https://docs.xquik.com/mcp`, then select **Create**.
    4. Open **Personal**, select Xquik Docs & select **+** to install it.
    5. Start a new chat. Type `@` & select Xquik Docs.

    The Docs MCP server only reads public documentation. It needs no authentication.
    Developer mode supports Plus, Pro, Business, Enterprise & Edu accounts on the web.
    Workspace admins control access. Create the connection on the web first.
    On mobile, use plugins available to your account.
    If Xquik Docs is unavailable on mobile, continue on the web.
    Follow [OpenAI's current setup guide](https://developers.openai.com/plugins/deploy/connect-chatgpt)
    when ChatGPT changes its labels.
  </Tab>
</Tabs>

### Coding agents

<Tabs>
  <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="GitHub Copilot CLI">
    ```bash theme={null}
    copilot mcp add --transport http xquik-docs https://docs.xquik.com/mcp
    ```

    If your installed build does not expose these flags, start Copilot CLI and
    run `/mcp add`. Choose **HTTP**, enter the server name and URL, keep `*` for
    tools, then press **Ctrl+S**. Verify it with `/mcp show xquik-docs`.
  </Tab>

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

    Or add this entry under `mcpServers` in `~/.gemini/settings.json` or
    `.gemini/settings.json`:

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

    Older Gemini CLI builds also accept the legacy `httpUrl` field.
  </Tab>
</Tabs>

### Additional coding agents

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

    Manual Qwen Code configuration still uses
    `httpUrl: "https://docs.xquik.com/mcp"` under `mcpServers`.
  </Tab>

  <Tab title="Goose">
    Start a session with the Docs MCP extension:

    ```bash theme={null}
    goose session --with-streamable-http-extension https://docs.xquik.com/mcp
    ```

    Docs MCP needs no OAuth or API-key header.
  </Tab>

  <Tab title="Pi">
    Pi 1.0.0 has native MCP. Add the public Docs MCP server:

    ```bash theme={null}
    pi mcp add xquik-docs --url https://docs.xquik.com/mcp
    pi mcp list
    ```

    No authentication is required.
    If your build lacks `pi mcp`, run `pi update self` before setup.
    See [Pi configuration](/mcp/coding-agents#pi).
  </Tab>
</Tabs>

See [current coding-agent configuration](/mcp/coding-agents) for version-specific changes.

### Editor clients

<Tabs>
  <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 `.mcp.json` for portable project setup:

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

    Existing `.vscode/mcp.json` entries still use the top-level `servers` object.
  </Tab>

  <Tab title="Windsurf">
    For legacy Cascade, open its **MCP config file**. Current Devin Desktop uses
    `~/.config/devin/mcp_config.json`; older Windsurf used
    `~/.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>
</Tabs>

### Additional editors

<Tabs>
  <Tab title="Cline">
    Run `cline mcp`, add a Streamable HTTP server, and enter
    `https://docs.xquik.com/mcp`. In the IDE, use the **MCP Remote Servers** UI.
    Cline stores global MCP settings at
    `~/.cline/data/settings/cline_mcp_settings.json`. Project settings use
    `.cline/mcp.json`.
  </Tab>

  <Tab title="Roo Code">
    Roo Code is archived. Its final release can still connect to this
    authentication-free server. Add to project `.roo/mcp.json` or global
    `mcp_settings.json`:

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

## Using both MCP servers

Connect both servers:

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 such as tweet searches, extractions, and monitor setup.

The AI decides which server to query based on context. A question about how draw filters work goes to the docs server. A request to run a draw goes to 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.

## What gets searched

The docs MCP server indexes all public pages:

* API reference (every documented operation)
* 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` (compact documentation index)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.