Redash

🚀 Redfire MCP Server

The Model Context Protocol (MCP) server is used to integrate Redash with AI assistants like Claude. It enables seamless interaction between Redash and AI tools, enhancing data retrieval and management capabilities.

✨ Features

• Connect to a Redash instance via the Redash API.
• List available queries and dashboards as resources.
• Execute queries and retrieve results.
• Create and manage queries (create, update, archive).
• List data sources available for query creation.
• Obtain dashboard details and visualizations.

📋 Prerequisites

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

🌐 Environment Variables

The server requires the following environment variables:

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

Optional variables:

• REDASH_TIMEOUT: Timeout for API requests in milliseconds (default is 30000).
• REDASH_MAX_RESULTS: Maximum number of results to return (default is 1000).

📦 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 containing Redash configuration:

   REDASH_URL=https://your-redash-instance.com
   REDASH_API_KEY=your_api_key
   

4. Build the project:

   npm run build
   

5. Start the server:

   npm start
   

💻 Usage Examples

Basic Usage

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

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

Add the following configuration (edit the 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"
      }
    }
  }
}

Advanced Usage

The server provides a set of useful tools for query and dashboard management:

Query Management

• list-queries: List all available queries in Redash.
• get-query: Get detailed information about a specific query.
• create-query: Create a new query in Redash.
• update-query: Update an existing query.
• archive-query: Archive (soft delete) a query.
• list-data-sources: List all available data sources for query creation.

Query Execution

• execute-query: Execute a query and return the results.

Dashboard Management

• list-dashboards: List all available dashboards.
• get-dashboard: Get dashboard details and visualizations.
• get-visualization: Get detailed information about a specific visualization.

🔧 Technical Details

To run the server in development mode, use the following command:

npm run dev

📜 Version History

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

📄 License

This project is licensed under the MIT license.