redash-mcp

redash-mcp

English | 한국어 | 日本語

将 Redash 连接到 Claude、Cursor、Gemini CLI、Codex 和任何 MCP 客户端的 MCP 服务——通过自然语言查询数据、构建图表和仪表盘，并运行 SQL。

安装 · 工具 · 环境变量 · 示例 · 故障排除 · 隐私

3.5 版本更新内容

• create_visualization — 为已保存的查询创建折线图 / 柱状图 / 面积图 / 饼图 / 散点图或计数器。如果查询已运行，会根据其最新结果检查列名，因此输入错误会返回错误，而不是生成空图表。
• 仪表盘自动布局 — add_widget 会将新小组件放在现有小组件下方；半宽小组件会并排放置（之前它们都会重叠在左上角）。

完整历史记录：版本发布

为什么选择 redash-mcp？

专为让大模型安全地访问生产数据而构建：

• 🛡️ SQL 安全防护 — 阻止 DROP / TRUNCATE / ALTER，以及不带 WHERE 的 DELETE / UPDATE；支持 strict / warn / off 模式、PII 检测和自动添加 LIMIT。
• 🧠 BIRD 智能查询 — 分析问题、自动选择表，并引导生成 SQL（BIRD text-to-SQL）。可选 Claude Haiku 备用方案。
• 📊 端到端 — 查询、保存、图表、仪表盘和警报——共 25 个工具。
• ⚡ 一条命令即可设置 — npx redash-mcp setup 可配置 Claude Desktop / Claude Code / Cursor / Gemini CLI / Codex CLI。
• 🔒 完全本地运行 — 直接连接到你的 Redash。API 密钥和结果绝不会离开你的设备。

安装

要求： Node.js 20+ 和 Redash API 密钥（Redash → Profile → Edit Profile → API Key）。

npx redash-mcp setup

向导可配置 Claude Desktop、Claude Code、Cursor、Gemini CLI 和 Codex CLI 的任意组合。

也可以一次性安装 Node.js、Claude Desktop 和 MCP 配置：

curl -fsSL https://raw.githubusercontent.com/seob717/redash-mcp/main/install.sh | bash

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

claude mcp add --scope user redash-mcp \
  -e REDASH_URL=https://your-redash-instance.com \
  -e REDASH_API_KEY=your_api_key_here \
  -- npx -y redash-mcp

gemini mcp add -s user \
  -e REDASH_URL=https://your-redash-instance.com \
  -e REDASH_API_KEY=your_api_key_here \
  redash-mcp npx -y redash-mcp

codex mcp add redash-mcp \
  --env REDASH_URL=https://your-redash-instance.com \
  --env REDASH_API_KEY=your_api_key_here \
  -- npx -y redash-mcp

SQL 安全防护

适用于通过 run_query 执行的临时 SQL。通过 get_query_result 执行的已保存查询不会经过检查，因此请为 Redash 数据源提供只读数据库账户。

• 始终禁止（除非 REDASH_SAFETY_MODE=off）：DROP、TRUNCATE、ALTER TABLE、GRANT/REVOKE、不带 WHERE 的 DELETE/UPDATE
• 发出警告（warn）/禁止（strict）：SELECT *、不带 WHERE 或 LIMIT 的查询、访问 PII 列
• 自动添加 LIMIT：当设置了 REDASH_AUTO_LIMIT 时，追加 LIMIT N

详情请参阅：docs/sql-safety-guard.md。查询结果也会缓存在内存中（见下方的 REDASH_MCP_CACHE_*）。

环境变量

使用示例

只需用自然语言提问：

• “本月有多少新用户注册？” → smart_query 选择表格 → run_query
• “上周新用户中有多少比例进行了购买？” → smart_query 指引 JOIN → run_query
• “当每日注册人数低于 100 时创建警报” → create_alert

构建仪表板：“保存一条月收入查询，将其制作为折线图，并放到新的 Revenue 仪表板上。”

1. create_query — 保存“月收入”
2. get_query_result — 运行一次，以便检查图表列
3. create_visualization — type: "line"、x_column: "month"、y_columns: ["revenue"]
4. create_dashboard — 创建“Revenue”
5. add_widget — 放置图表；更多小组件会堆叠在下方或并排放置

故障排查

开发

npm install
npm run dev     # run from source (tsx)
npm test        # vitest
npm run build   # typecheck + bundle to dist/

隐私政策

redash-mcp 是一个本地 MCP 服务，可直接与您的 Redash 实例通信，不涉及任何中间服务。

我们不会向第三方出售或共享用户数据。

保留期限： 配置文件会保留在 ~/.redash-mcp/ 中，直到您将其删除；查询缓存存储在内存中，并在关闭时清除；架构缓存存储在内存中，TTL 为 10 分钟。

联系方式： 可通过 GitHub Issues 提交咨询和安全报告。

免责声明

redash-mcp 是一项非官方的社区构建集成，与 Redash 无关，也未获得其认可或赞助。“Redash”是其各自所有者的商标，在此仅用于说明兼容性。本项目仅通过 Redash 的公共 REST API 与其通信。

许可证

MIT