Connect an AI Assistant to EQQ¶
EQQ exposes every Active query two ways for programmatic access: a plain REST API, and an MCP endpoint built for AI assistants. Both reuse the same query catalog and permissions you already set up - there's nothing separate to install or deploy.
Get an API key¶
Navigate: click your username (top right) → My Account → Create New API Key. Give it a display name, optionally set an expiration, click Create API Key, and copy it immediately - EQQ shows it once.
Option A - Call the REST API directly¶
Every Active query is already an endpoint. From Data Visualization → Query To JSON, pick a query and click Generate Code Snippet to get a ready-to-run curl command with the real endpoint and headers filled in. See the REST API Reference for the full request/response shapes.
Option B - Connect an MCP client¶
EQQ's MCP endpoint is part of the main application - there's no separate gateway process to install or run. It lives at:
Point any MCP-capable client (Claude Desktop, Claude Code, Cursor, Copilot) at that URL. Unlike a typical MCP server, EQQ doesn't take the API key as a connection header - your client passes it as an apiKey argument on every tool call, so check that your client's MCP setup supports per-call arguments (most do).
Once connected, your assistant can call:
| Tool | What it does |
|---|---|
get_user_profile |
Look up the API key owner's role and profile |
list_queries / list_databases |
Discover what's available |
get_query_detail / get_query_parameters |
Inspect a query before running it |
execute_query / execute_query_next_page |
Run a query, page through large results |
start_stream / resume_stream |
Stream very large results in chunks |
export_query |
Export a result as xlsx/csv/json |
execute_chart_query |
Run a query with chart-ready column classification |
See the MCP Gateway reference for the full protocol details, tool schemas, and troubleshooting.
What's next?¶
| I want to... | Go here |
|---|---|
| See every MCP tool's exact input/output schema | Reference: MCP Gateway |
| See every REST endpoint in depth | Reference: REST API Reference |
| Manage or revoke API keys | Reference: Account & Security |