Overview - Allium Documentation Hub

Allium’s MCP Server gives your AI agents blockchain data through Model Context Protocol tool calls. The server URL is https://mcp.allium.so. Sign in with your Allium account (recommended), or send an API key.

mcp-oauth.allium.so is deprecated and stops working after 31 October 2026. If you use it, change the URL to https://mcp.allium.so and sign in again.

Quick start

Add the server to your client

Add https://mcp.allium.so as a custom MCP server or connector, and choose OAuth authentication if your client asks.Per-client steps for ChatGPT, Claude, and Copilot Studio are below.

Your client opens Allium’s login page. Sign in with your Allium account and approve access.

Start querying

Ask your agent to query blockchain data. It now has access to 85+ chains via Allium.

Using a coding agent? With our installer, building on Allium is super straightforward:

npx @allium-labs/mcp install --client claude-code --yes

See Coding agents and CLIs for the full client list.

What your agent can do

SQL & queries

Run SQL, save reusable Explorer queries, choose a compute profile

Knowledge & discovery

Search schemas, docs, and analyst-built Terminal dashboards

Dashboards & sharing

Build visuals and dashboards, publish share and embed links

Realtime data

Prices, balances, transactions, DeFi positions, holdings PnL

Hyperliquid

Info, fills, orders, and orderbooks through a rate-limit-free proxy

Skills

Load Allium’s own SQL and dashboard guidance into your agent

Have your agent call get_skill(name="sql-optimization") before it writes SQL, and get_realtime_supported_chains once per session before any realtime tool.

Chatbots

ChatGPT
Claude
Microsoft Copilot
Gemini

Note: Requires ChatGPT Plus, Pro, or Team plan.ChatGPT supports MCP servers as “Apps,” so you can ask about on-chain data directly in your chat.

Click on your username in the bottom left
Go to Settings
Navigate to Apps
Go to Advanced Settings
Select and turn on Developer Mode
Click Create App
Set MCP Server URL to: https://mcp.allium.so
Select OAuth as authentication

In a chat, select the + icon and turn on the Allium MCP App.

Note: Requires Claude Pro, Max, Team, or Enterprise plan.Claude supports MCP servers as “connectors,” so you can ask about on-chain data directly in your chat.

Click on your user icon in the bottom left
Go to Settings (Pro / Max plans) or Organization Settings (Team / Enterprise plans)
Navigate to Connectors
Scroll down to Add Custom Connector
Add https://mcp.allium.so as the Remote MCP Server URL
(On Settings > Connectors) Find the Allium Custom Connector and click “Connect”
Sign in with your Allium account, using Google, SSO, or email

In a chat, select the + icon and turn on the Allium connector.

Note: Requires Copilot Studio to configure MCP servers. Copilot Studio connects with an API key.Build custom agents and workflows in Copilot Studio that pull live blockchain data from Allium.

Click Create blank agent
Click on Tools
Select Add a Tool then Model Context Protocol
Add https://mcp.allium.so as the Server URL
Select API key authentication, set the header name to Authorization, and click Create
Once the connector has been created, select Connection > Create new connection
Copy your API key from https://app.allium.so/settings/api-keys. Paste Bearer <your-api-key> into Copilot
Click Create, then Add and configure

Copilot Studio discovers Allium’s tools and keeps them in sync. You choose which tools to enable, combine them with other connectors, and deploy the agent to Teams, Power Automate, or a custom app. See the Copilot Studio MCP documentation for the full setup.

Gemini web does not currently support MCP. Use Gemini CLI instead:

npx @allium-labs/mcp install --client gemini-cli --yes

Gemini CLI signs in on first use. See Coding agents and CLIs.

Want support for another chatbot platform? Reach out to [email protected].

Coding agents and CLIs

Claude Code, Cursor, Codex and the other CLI clients sign in with your Allium account. The installer writes the server into the client’s config file:

npx @allium-labs/mcp install --client claude-code --yes

Swap claude-code for your client’s slug.

Client	Slug	Sign-in
Claude Code	`claude-code`	Run `/mcp`, select allium
Cursor	`cursor`	On first use
Claude Desktop	`claude`	On first use
Codex	`codex`	Run `codex mcp login allium`
VS Code (GitHub Copilot)	`vscode`	On first use
Cline	`cline`	On first use
Windsurf	`windsurf`	On first use
Warp	`warp`	On first use
Gemini CLI	`gemini-cli`	On first use
Goose	`goose`	On first use
Zed	`zed`	On first use
OpenCode	`opencode`	On first use
Tabnine	`tabnine`	On first use
Roo Code	`roo-cline`	API key only, see below

Roo Code cannot sign in yet. Its OAuth 2.1 issue is still open, so install it with a key instead:

npx @allium-labs/mcp install --client roo-cline --api-key YOUR_KEY --yes

To configure a client by hand, point it at https://mcp.allium.so and choose OAuth authentication if it asks:

Claude Code
Cursor
Codex

claude mcp add --scope user --transport http allium https://mcp.allium.so

Then run /mcp, select allium, and finish the login in your browser.

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

{
  "mcpServers": {
    "allium": {
      "url": "https://mcp.allium.so"
    }
  }
}

Then restart Cursor.

codex mcp add allium --url https://mcp.allium.so
codex mcp login allium

Don’t see your client listed? Reach out to [email protected].

API key authentication

For autonomous agents, CI, and clients that can’t sign in. Generate a key at app.allium.so/settings/api-keys. Connect to https://mcp.allium.so and send the key in an Authorization: Bearer <your-api-key> header.

The X-API-KEY header still works, but it is deprecated. Use Authorization: Bearer for new setups. You store and rotate the key yourself, so prefer sign-in where your client supports it. Both paths reach the same tools.

Automatic setup

The installer takes a key with --api-key, which also skips the browser step:

npx @allium-labs/mcp install --client claude-code --api-key YOUR_KEY --yes

Client slugs are listed under Coding agents and CLIs.

Manual setup

claude mcp add --scope user --transport http allium https://mcp.allium.so --header "Authorization: Bearer <your-api-key>"

Then restart Claude Code.

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

{
  "mcpServers": {
    "allium": {
      "url": "https://mcp.allium.so",
      "headers": {
        "Authorization": "Bearer <your-api-key>"
      }
    }
  }
}

Then restart Cursor.

Add the server:

codex mcp add allium --url https://mcp.allium.so

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

[mcp_servers.allium]
url = "https://mcp.allium.so"
http_headers = { "Authorization" = "Bearer <your-api-key>" }

Then restart Codex.

{
  "tools": [
    {
      "name": "run_sql_query",
      "server": "https://mcp.allium.so",
      "headers": {
        "Authorization": "Bearer <YOUR_API_KEY>"
      }
    },
    {
      "name": "get_query_run_results",
      "server": "https://mcp.allium.so",
      "headers": {
        "Authorization": "Bearer <YOUR_API_KEY>"
      }
    }
  ]
}

Register search_schemas and search_docs the same way. An agent needs them to find the right tables before it writes SQL. Add any of the other available tools as needed.

Query execution is asynchronous: run_sql_query returns a run_id, and get_query_run_results fetches the rows. Register both, or your agent will never see its results. See SQL & queries.

For streamable-http or other CLI-based setups:

{
  "mcpServers": {
    "allium": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://mcp.allium.so",
        "--header",
        "Authorization:${AUTH_HEADER}"
      ],
      "env": {
        "AUTH_HEADER": "Bearer <your-api-key>"
      }
    }
  }
}

The key comes from the environment rather than the config file.

Configure your MCP client to connect to https://mcp.allium.so. Set the Authorization header to Bearer <your-api-key>.Most MCP clients support HTTP transport with custom headers. See your client’s documentation for the exact syntax.

Toolsets

Toolsets let your agent load only the tools it needs, which saves context window space. To select toolsets, add the toolsets query parameter to the server URL. It works with sign-in and with API keys.

Load every tool (the default if you leave out toolsets):
https://mcp.allium.so

Load only the realtime tools:

https://mcp.allium.so?toolsets=realtime

Load the core, Explorer, and realtime tools:

https://mcp.allium.so?toolsets=core,explorer,realtime

Separate toolset names with commas. Your agent gets every tool in any toolset you list, plus tools that belong to no toolset. toolsets=all is the same as leaving the parameter out, and the server ignores names it doesn’t recognize. In Claude Code, put the full URL in quotes:

claude mcp add --scope user --transport http allium "https://mcp.allium.so?toolsets=core,realtime"

If your agent’s context is tight, start with core and add toolsets as you need them.

Available toolsets

Toolset	Use it for	Tools
`core`	The everyday analyst loop: docs, schemas, skills, SQL, dashboards, and Terminal	`search_docs`, `browse_docs`, `search_schemas`, `list_skills`, `get_skill`, `run_sql_query`, `get_query_run_results`, `list_compute_profiles`, `read_dashboard`, `search_dashboards`, `set_dashboard`, `share_dashboard`, `search_terminal`, `get_terminal_results`, `list_catalog_metrics`, `get_catalog_metric`
`docs`	Searching and reading Allium’s documentation	`search_docs`, `browse_docs`
`explorer`	Saved Explorer queries and visuals	`create_explorer_query`, `get_explorer_query`, `update_explorer_query`, `list_explorer_queries`, `run_explorer_query`, `delete_explorer_query`, `share_explorer_query`, `create_explorer_visual`, `get_explorer_visual`, `delete_explorer_visual`
`dashboards`	Reading, building, and sharing dashboards	`read_dashboard`, `search_dashboards`, `set_dashboard`, `share_dashboard`, `delete_dashboard`
`terminal`	Analyst-built Terminal dashboards and their results	`search_terminal`, `get_terminal_results`
`catalog`	Catalog metrics, for organizations with access	`list_catalog_metrics`, `get_catalog_metric`
`realtime`	Prices, balances, transactions, positions, PnL, tokens, and Hyperliquid	Every `get_realtime_`, `list_realtime_`, and `search_realtime_*` tool. See Realtime data and Hyperliquid.

A tool outside your selected toolsets is not listed, and a call to it returns an unknown-tool error. Feature gates still apply inside a toolset. See Tool visibility.

Plugins

Extend your agent with the allium-analyst plugin

Tools Reference

Every tool, by category

Billing & limits

Which tools cost credits, and the row and poll caps

Examples

What customers build with MCP

Run Queries

Learn how to save queries in Explorer and obtain a query ID

Explorer API

REST endpoints for running queries and retrieving results

​Quick start

​What your agent can do

SQL & queries

Knowledge & discovery

Dashboards & sharing

Realtime data

Hyperliquid

Skills

​Chatbots

​Coding agents and CLIs

​API key authentication

​Automatic setup

​Manual setup

​Toolsets

​Available toolsets

​Related resources

Plugins

Tools Reference

Billing & limits

Examples

Run Queries

Explorer API

Quick start

What your agent can do

Chatbots

Coding agents and CLIs

API key authentication

Automatic setup

Manual setup

Toolsets

Available toolsets

Related resources