JinDaGe - Redash MCP Details

article

README

🚀 红火 MCP 服务器

红火 MCP 服务器基于模型上下文协议（MCP）构建，其核心价值在于搭建起红火（Redash）与人工智能助手（如 Claude）之间的桥梁，实现两者的高效集成，为数据查询和管理提供便利。

🚀 快速开始

红火 MCP 服务器可将 Redash 与人工智能助手集成。要使用该服务器，需先完成安装和配置，之后就能借助它执行各类查询、管理资源等操作。

✨ 主要特性

🔗 通过 Redash API 连接到 Redash 实例，实现数据交互。
📜 列出可用的查询和仪表板作为资源，方便用户查看。
📊 执行查询并获取结果，满足数据查询需求。
🛠️ 创建和管理查询（创建、更新、存档），灵活处理查询任务。
💾 列出可用于查询创建的数据源，为查询提供数据支持。
📈 获取仪表板详细信息和可视化，直观展示数据。

📦 安装指南

先决条件

Node.js (v18 或更高版本)
npm 或 yarn
对 Redash 实例的访问权限
Redash API 密钥

环境变量

服务器需要以下环境变量：

REDASH_URL：您的 Redash 实例 URL（例如，https://redash.example.com）
REDASH_API_KEY：您的 Redash API 密钥

可选变量：

REDASH_TIMEOUT：API 请求的超时时间（单位：毫秒，默认值为 30000）
REDASH_MAX_RESULTS：返回的最大结果数（默认值为 1000）

安装步骤

克隆此仓库：

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

安装依赖项：
```
npm install
```

创建包含 Redash 配置的.env文件：

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

构建项目：
```
npm run build
```
启动服务器：
```
npm start
```

💻 使用示例

与 Claude 桌面一起使用

要将此 MCP 服务器与 Claude 桌面集成，配置到您的 Claude 桌面配置文件中：

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

添加以下配置（根据需要编辑路径）：

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

可用工具

查询管理

list - queries：列出 Redash 中的所有可用查询
get - query：获取特定查询的详细信息
create - query：在 Redash 中创建新的查询
update - query：更新现有的查询
archive - query：存档（软删除）一个查询
list - data - sources：列出所有可用的数据源

查询执行

execute - query：执行查询并返回结果

仪表板管理

list - dashboards：列出所有可用的仪表板
get - dashboard：获取仪表板详细信息和可视化
get - visualization：获取特定可视化的详细信息

🔧 技术细节

开发模式

以开发模式运行：

npm run dev

版本历史

v1.1.0：添加了查询管理功能（创建、更新、存档）
v1.0.0：初始版本

📄 许可证

本项目采用 MIT 许可证。

Redash