> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Query blockchain data from Allium Explorer using MCP.

Allium's MCP Server lets your AI agents query blockchain data using structured tool calls—no REST or custom glue code required. Agents can run saved Explorer queries, execute raw SQL, and introspect Allium schemas via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/).

<Tip>
  **Using a chatbot like ChatGPT, Claude, or Copilot?** See the [Chatbots](#chatbots) section for setup instructions.
</Tip>

## Quick Start

Get connected in under 30 seconds:

<Steps>
  <Step title="Run the installer">
    ```bash theme={null}
    npx @allium-labs/mcp install
    ```

    The installer will prompt you to select your AI tool and enter your API key. It supports Claude Code, Cursor, VS Code, Windsurf, and [10+ other clients](#supported-clients).
  </Step>

  <Step title="Get an API Key">
    Generate an API key at [app.allium.so/settings/api-keys](https://app.allium.so/settings/api-keys).
  </Step>

  <Step title="Restart your client">
    Restart your AI tool to load the new MCP server.
  </Step>

  <Step title="Start Querying">
    Ask your agent to query blockchain data—it now has access to 80+ chains via Allium.
  </Step>
</Steps>

<Accordion title="Prefer manual setup?">
  See the [API Key Authentication](#api-key-authentication) section below for manual configuration instructions.
</Accordion>

## Key Benefits

<CardGroup cols={2}>
  <Card title="Structured Tool Calls" icon="code">
    No REST API glue code needed—agents use standard MCP tool calls
  </Card>

  <Card title="Schema Discovery" icon="search">
    Semantic search and introspection of Allium's data schemas
  </Card>

  <Card title="Universal Compatibility" icon="plug">
    Works with any MCP-compatible agent framework
  </Card>

  <Card title="Production Ready" icon="shield-check">
    Reliable access to Allium's enterprise-grade blockchain data
  </Card>
</CardGroup>

## API Key Authentication

<Note>
  **Recommended for most users.** API key auth works with all coding agents and MCP clients. Generate a key at [app.allium.so/settings/api-keys](https://app.allium.so/settings/api-keys).
</Note>

### Automatic Setup

The fastest way to get started — works with 13+ clients:

```bash theme={null}
npx @allium-labs/mcp install
```

For non-interactive environments (CI/CD, scripts):

```bash theme={null}
npx @allium-labs/mcp install --client claude-code --api-key YOUR_KEY --yes
```

### Supported Clients

The installer supports the following clients:

**Claude Code, Cursor, Claude Desktop, VS Code (GitHub Copilot), Codex, Cline, RooCline, Windsurf, Warp, Gemini CLI, Goose, Zed, and Opencode.**

<Note>
  Don't see your client listed? Reach out to [contact@allium.so](mailto:contact@allium.so) and we'll add support for it.
</Note>

### Manual Setup

If you prefer to configure manually:

<Tabs>
  <Tab title="Claude Code">
    ```bash theme={null}
    claude mcp add --scope user --transport http allium https://mcp.allium.so --header "X-API-KEY: <your-api-key>"
    ```

    Then restart Claude Code.
  </Tab>

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

    ```json theme={null}
    {
      "mcpServers": {
        "allium": {
          "url": "https://mcp.allium.so",
          "headers": {
            "X-API-KEY": "<your-api-key>"
          }
        }
      }
    }
    ```

    Then restart Cursor.
  </Tab>

  <Tab title="Codex">
    Add the server:

    ```bash theme={null}
    codex mcp add allium --url https://mcp.allium.so
    ```

    Then add your API key to `~/.codex/config.toml`:

    ```toml theme={null}
    [mcp_servers.allium]
    url = "https://mcp.allium.so"
    http_headers = { "X-API-KEY" = "<your-api-key>" }
    ```

    Then restart Codex.
  </Tab>

  <Tab title="LangGraph / LangChain">
    Register tools in your agent configuration:

    ```json theme={null}
    {
      "tools": [
        {
          "name": "explorer_run_query",
          "server": "https://mcp.allium.so",
          "headers": {
            "X-API-KEY": "<YOUR_API_KEY>"
          }
        },
        {
          "name": "explorer_run_sql",
          "server": "https://mcp.allium.so",
          "headers": {
            "X-API-KEY": "<YOUR_API_KEY>"
          }
        }
      ]
    }
    ```

    Add `explorer_fetch_schema` and `explorer_search_schemas` the same way. You can also add any of the [Realtime API tools](/ai/mcp/tools-reference/realtime).
  </Tab>

  <Tab title="mcp-remote / CLI">
    For `streamable-http` or other CLI-based setups:

    ```json theme={null}
    {
      "mcpServers": {
        "allium": {
          "command": "npx",
          "args": [
            "mcp-remote",
            "https://mcp.allium.so",
            "--header",
            "X-API-KEY:${API_KEY}"
          ],
          "env": {
            "API_KEY": "<your-api-key>"
          }
        }
      }
    }
    ```

    This enables local agent tool streaming with auth injected from environment variables.
  </Tab>

  <Tab title="Other Clients">
    Configure your MCP client to connect to `https://mcp.allium.so` with the `X-API-KEY` header set to your API key.

    Most MCP clients support HTTP transport with custom headers. Refer to your client's documentation for specific configuration details.
  </Tab>
</Tabs>

***

## Chatbots

<Note>
  If you're using a coding agent like Claude Code or Cursor, use the [Quick Start](#quick-start) above instead.
</Note>

<Tabs>
  <Tab title="ChatGPT">
    **Note:** Requires ChatGPT Plus, Pro, or Team plan. MCP is not available on the free plan.

    ChatGPT supports MCP servers as "Apps," letting you ask questions about on-chain data directly in your chat -- no code required.

    <div style={{ position: "relative", paddingBottom: "56.25%", height: 0, overflow: "hidden", borderRadius: "0.5rem" }}>
      <iframe src="https://allium.navattic.com/dys0uaw" style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: "none" }} allow="fullscreen" />
    </div>

    Follow these steps to connect Allium MCP to ChatGPT:

    1. Click on your username in the bottom left
    2. Go to **Settings**
    3. Navigate to **Apps**
    4. Go to **Advanced Settings**
    5. Select and turn on **Developer Mode**
    6. Click **Create App**
    7. Set **MCP Server URL** to: `https://mcp-oauth.allium.so`
    8. Select **OAuth** as authentication

    That's it! By selecting the + icon and activating the Allium MCP App, you'll be able to instantly enhance your chats with Allium's data.
  </Tab>

  <Tab title="Claude">
    **Note:** Requires Claude Pro, Max, Team, or Enterprise plan.

    Claude supports MCP servers as "connectors," letting you ask questions about on-chain data directly in your chat -- no code required.

    <div style={{ position: "relative", paddingBottom: "56.25%", height: 0, overflow: "hidden", borderRadius: "0.5rem" }}>
      <iframe src="https://allium.navattic.com/l0x01fo" style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: "none" }} allow="fullscreen" />
    </div>

    Follow these steps to connect Allium MCP to Claude:

    1. Click on your user icon in the bottom left
    2. Go to **Settings** (Pro / Max plans) or **Organization Settings** (Team / Enterprise plans)
    3. Navigate to **Connectors**
    4. Scroll down to **Add Custom Connector**
    5. Add `https://mcp-oauth.allium.so` as the **Remote MCP Server URL**
    6. (On **Settings > Connectors**) Find the Allium Custom Connector and click **"Connect"**
    7. Log in with Google

    That's it! By selecting the + icon and activating the Allium connector, you'll be able to instantly enhance your chats with Allium's data.
  </Tab>

  <Tab title="Microsoft Copilot">
    **Note:** Requires Copilot Studio to configure MCP servers.

    With Copilot Studio, you can build custom agents and workflows that pull live blockchain data from Allium -- ideal for embedding on-chain insights into enterprise tools like Teams, Power Automate, or internal dashboards.

    <div style={{ position: "relative", paddingBottom: "56.25%", height: 0, overflow: "hidden", borderRadius: "0.5rem" }}>
      <iframe src="https://allium.navattic.com/z1270ni6" style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: "none" }} allow="fullscreen" />
    </div>

    Follow these steps to connect Allium MCP to Copilot Studio:

    1. Click **Create blank agent**
    2. Click on **Tools**
    3. Select **Add a Tool** then **Model Context Protocol**
    4. Add `https://mcp.allium.so` as the **Server URL**
    5. Select **API key** authentication, using the **X-API-KEY** header, and click **Create**
    6. Once the connector has been created, select **Connection > Create new connection**
    7. Copy your API key from `https://app.allium.so/settings/api-keys` and paste it into Copilot
    8. Click **Create**, then **Add and configure**

    Once connected, Copilot Studio automatically discovers Allium's tools and keeps them in sync — you can selectively enable individual tools, combine them with other connectors, and deploy your agent across Teams, Power Automate, and custom apps. See the [Copilot Studio MCP documentation](https://learn.microsoft.com/en-us/microsoft-copilot-studio/mcp-add-components-to-agent) for full detailed integration instructions.
  </Tab>

  <Tab title="Gemini">
    Gemini web does not currently support MCP. However, you can use **Gemini CLI** with API key authentication:

    ```bash theme={null}
    npx @allium-labs/mcp install
    ```

    Select "Gemini CLI" when prompted. See the [Quick Start](#quick-start) for full instructions.
  </Tab>
</Tabs>

<Note>
  Want support for another chatbot platform? Reach out to [contact@allium.so](mailto:contact@allium.so).
</Note>

## Related Resources

<CardGroup cols={2}>
  <Card title="Tools Reference" icon="code" href="/ai/mcp/tools-reference/overview">
    Detailed documentation for all MCP tools
  </Card>

  <Card title="Examples" icon="book" href="/ai/mcp/examples">
    Real interaction transcripts
  </Card>

  <Card title="Run Queries" icon="rotate" href="/app/run-queries">
    Learn how to save queries in Explorer and obtain a query ID
  </Card>

  <Card title="Explorer API" icon="code" href="/api/explorer/overview">
    REST endpoints for running queries and retrieving results
  </Card>
</CardGroup>