This guide explains how to connect Command Line Interface (CLI)-based AI tools — Claude Code CLI, OpenAI's Codex CLI, and Gemini CLI — to the Ardoq MCP server.
Once connected, these tools can access and interact with your Ardoq model data directly from your terminal.
In This Guide
Prerequisites
Node.js v18 or higher
Node is a requirement for all of these command line clients. If you don’t already have Node.js installed:
Go to nodejs.org/en/download
Download the LTS version for your operating system
Follow the installation instructions
To confirm the installation, open a terminal and run:
node --version
You should see a version number like v18.17.1.
Claude Code CLI
1. Install Claude Code
Open your terminal and run:
npm install -g @anthropic-ai/claude-code
Authenticate with Anthropic:
claude
The first time you run Claude Code, you’ll be prompted to sign in through Anthropic’s OAuth process. Follow the on-screen steps.
2. Configure Claude Code to Use the Ardoq MCP Server
Once signed in, add the Ardoq MCP server with this command:
claude mcp add --transport http ardoq-mcp https://<your-org>.ardoq.com/mcp/ --header "Authorization:Bearer <your-token>"
Replace:
<your-org>with your Ardoq org hostname<your-token>with your Ardoq API token
This securely connects Claude Code to your Ardoq MCP server.
3. Test the Integration
To verify the connection:
In your terminal, launch Claude Code by running:
claude
Once Claude opens, check your connection by prompting:
Check my connection to Ardoq MCP
or type a question such as:
Please show me the reports I have in Ardoq
If everything is configured correctly, Claude will fetch real-time reports from your Ardoq MCP server.
You can also try:
Can you give me more information about <report name>
Claude will then retrieve detailed information about that specific report from your Ardoq workspace.
Codex CLI
1. Install Codex
Open your terminal and run:
npm i -g @openai/codex
Then start Codex:
codex
When prompted, select 1. Sign in with ChatGPT, and follow the prompts to complete authentication.
When asked for permissions, choose the recommended option.
2. Configure Codex to Use the Ardoq MCP Server
Once signed in, connect Codex to your Ardoq MCP server with:
codex mcp add ardoq-mcp -- npx -y mcp-remote@latest https://<your-org>.ardoq.com/mcp/ --header "Authorization:Bearer <your-token>"
Replace:
<your-org>with your Ardoq organization hostname<your-token>with your Ardoq API token
This securely connects Codex to your Ardoq MCP server.
3. Test the Integration
In your terminal, launch Codex again with:
codex
Once Codex is open, check your connection by prompting:
Check my connection to Ardoq MCP
or type a question such as:
Please show me the reports I have in Ardoq
If configured correctly, Codex will fetch your Ardoq reports directly from the MCP server.
You can also try:
Can you give me more information about <report name>
Codex will then retrieve detailed information from your Ardoq workspace.
Gemini CLI
1. Install Gemini CLI
Open your terminal and run:
npm install -g @google/gemini-cli
Then start Gemini:
gemini
When prompted, select 1. Login with Google and complete the sign-in flow in your browser.
Optionally, you can also authenticate using an API key instead of Google login:
# With Gemini API Key
export GEMINI_API_KEY="YOUR_API_KEY"
# With Vertex AI
export GOOGLE_API_KEY="YOUR_API_KEY"
export GOOGLE_GENAI_USE_VERTEXAI=true
2. Configure Gemini to Use the Ardoq MCP Server
Once authenticated, connect Gemini to your Ardoq MCP server with:
gemini mcp add --transport http ardoq-mcp https://<your-org>.ardoq.com/mcp/ --header "Authorization:Bearer <your-token>"
Replace:
<your-org>with your Ardoq organization hostname<your-token>with your Ardoq API token
This securely connects Gemini to your Ardoq MCP server.
3. Test the Integration
To verify that the connection works, start Gemini again:
gemini
Once Gemini is open, check your connection by prompting:
Check my connection to Ardoq MCP
or type a question such as:
Please show me the reports I have in Ardoq
If everything is configured correctly, Gemini will fetch your Ardoq reports through the MCP connection.
You can also try:
Can you give me more information about <report name>
Gemini will then retrieve detailed report information from your Ardoq workspace.