Redash MCP Server

Redash MCP Server

Model Context Protocol (MCP) server for integrating Redash with AI assistants like Claude.

Features

• Connect to Redash instances via the Redash API
• List available queries and dashboards as resources
• Execute queries and retrieve results
• Execute saved parameterized queries with typed values and saved defaults
• Create and manage queries (create, update, archive)
• Manage query parameters, dashboard parameters, and widget parameter mappings
• Inspect and update dashboard widget layouts and grid positions
• List data sources for query creation
• Get dashboard details and visualizations
• Update chart visualization options with Redash chart-specific settings

Prerequisites

• Node.js (v18 or later)
• npm or yarn
• Access to a Redash instance
• Redash API key

Environment Variables

The server requires the following environment variables:

• REDASH_URL: Your Redash instance URL (e.g., https://redash.example.com)
• REDASH_API_KEY: Your Redash API key

Optional variables:

• REDASH_TIMEOUT: Timeout for API requests in milliseconds (default: 30000)
• REDASH_MAX_RESULTS: Maximum number of results to return (default: 1000)
• REDASH_EXTRA_HEADERS: Extra HTTP headers to include with every Redash request. Accepts either a JSON object string or a semicolon/comma-separated list of key=value pairs.
• REDASH_SOCKS_PROXY: SOCKS proxy URL for routing requests through a proxy (e.g., socks5h://localhost:1080). Use socks5h:// (with h) to delegate DNS resolution to the proxy, which is required for internal hostnames that don't resolve on the local machine.

Examples:

JSON (recommended):

REDASH_EXTRA_HEADERS='{"CF-Access-Client-Id":"<client_id>","CF-Access-Client-Secret":"<client_secret>"}'

Key/value list:

REDASH_EXTRA_HEADERS=CF-Access-Client-Id=<client_id>;CF-Access-Client-Secret=<client_secret>

Notes:

• The Authorization header is managed by the server (Key <REDASH_API_KEY>) and cannot be overridden.
• All extra headers are added to every request made to Redash.

Installation

1. Clone this repository:

   git clone https://github.com/suthio/redash-mcp.git
   cd redash-mcp
   

2. Install dependencies:

   npm install
   

3. Create a .env file with your Redash configuration:

   REDASH_URL=https://your-redash-instance.com
   REDASH_API_KEY=your_api_key
   # Optional: Cloudflare Access (or other gateway) headers
   # REDASH_EXTRA_HEADERS='{"CF-Access-Client-Id":"<client_id>","CF-Access-Client-Secret":"<client_secret>"}'
   

4. Build the project:

   npm run build
   

5. Start the server:

   npm start
   

Usage with Claude for Desktop

To use this MCP server with Claude for Desktop, configure it in your Claude for Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the following configuration (edit paths as needed):

{
  "mcpServers": {
    "redash": {
      "command": "npx",
      "args": [
         "-y",
         "@suthio/redash-mcp"
      ],
      "env": {
        "REDASH_API_KEY": "your-api-key",
        "REDASH_URL": "https://your-redash-instance.com"
      }
    }
  }
}

Available Tools

Query Management

• list-queries: List all available queries in Redash
• get-query: Get details of a specific query
• create-query: Create a new query in Redash
• update-query: Update an existing query in Redash
• get-query-parameters: Inspect saved query parameter definitions
• update-query-parameters: Update saved query parameter definitions
• archive-query: Archive (soft-delete) a query
• list-data-sources: List all available data sources

Query Execution

• execute-query: Execute a query and return results, with optional maxAge
• execute-parameterized-query: Execute a saved parameterized query with type-aware value coercion, saved defaults, and optional maxAge
• execute-adhoc-query: Execute an ad-hoc query without saving it to Redash
• get-query-results-csv: Get query results in CSV format (supports optional refresh for latest data)

Dashboard Management

• list-dashboards: List all available dashboards
• get-dashboard: Get dashboard details and visualizations
• get-dashboard-layout: Inspect widget positions, sizes, and visibility on a dashboard
• get-visualization: Get details of a specific visualization
• get-dashboard-parameters: Inspect dashboard parameter values and widget mappings
• update-dashboard-parameters: Update dashboard parameter values and order
• update-dashboard-layout: Move or resize multiple widgets in one call
• update-widget-layout: Move or resize a single widget
• get-widget-parameter-mappings: Inspect a widget's parameter mappings
• update-widget-parameter-mappings: Update a widget's parameter mappings

Visualization Management

• create-visualization: Create a new visualization for a query
• update-visualization: Update an existing visualization
• update-chart-visualization: Patch chart-specific options like globalSeriesType, columnMapping, seriesOptions, legend, and axis settings
• delete-visualization: Delete a visualization

Development

Run in development mode:

npm run dev

Testing

Unit Tests

npm test

E2E Tests

npm run e2e:test

E2E tests use these default values (can be overridden with environment variables):

• REDASH_URL: https://demo.redash.io
• REDASH_API_KEY: test_api_key

Override example:

REDASH_URL=https://your-instance.com REDASH_API_KEY=your_key npm run e2e:test

Manual Testing

npm run inspector

Version History

• v1.1.0: Added query management functionality (create, update, archive)
• v1.0.0: Initial release

License

MIT