使用说明
项目简介
redash-mcp 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在桥接 Redash 数据分析平台和大型语言模型(LLM)应用。通过 redash-mcp,LLM 应用可以安全、便捷地访问 Redash 中存储的数据和分析能力,从而扩展 LLM 在数据驱动任务中的应用场景。
主要功能点
- 资源访问: 将 Redash 中的查询 (Queries) 和仪表板 (Dashboards) 作为资源暴露给 LLM 客户端,使得 LLM 能够理解和利用 Redash 中已有的数据分析成果。
- 工具集成: 提供丰富的工具 (Tools),例如执行查询、获取查询详情、创建/更新/归档查询、列出数据源和仪表板等,赋予 LLM 操作 Redash 的能力。
- 数据驱动的应用: 允许 LLM 通过调用工具获取 Redash 的数据分析结果,并将这些结果用于生成报告、回答问题、辅助决策等多种应用场景。
- 标准 MCP 协议: 遵循 MCP 协议标准,易于与任何兼容 MCP 协议的 LLM 客户端集成,例如 Claude for Desktop。
安装步骤
- 获取代码:
git clone https://github.com/suthio/redash-mcp.git cd redash-mcp - 安装依赖:
npm install - 配置 Redash 连接:
- 在项目根目录下创建 '.env' 文件。
- 编辑 '.env' 文件,填入您的 Redash 实例 URL 和 API 密钥:
REDASH_URL=您的Redash实例URL (例如: https://redash.example.com) REDASH_API_KEY=您的Redash API密钥
- 构建项目:
npm run build - 启动服务器:
npm start
服务器配置
对于支持 MCP 协议的 LLM 客户端,您需要配置 redash-mcp 服务器的启动信息。以 Claude for Desktop 为例,您需要在其配置文件中添加如下 JSON 配置:
{ "mcpServers": { "redash": { "command": "node", "args": ["/absolute/path/to/redash-mcp/dist/index.js"] // "command": 启动服务器的命令,这里使用 Node.js 运行 // "args": 命令参数,指向 redash-mcp 服务器的入口文件 (dist/index.js),请替换为您的实际路径 } } }
基本使用方法
启动 redash-mcp 服务器并配置到 MCP 客户端后,您可以通过客户端与 Redash 进行交互。例如,在 Claude for Desktop 中,您可以:
- 请求列出 Redash 查询和仪表板资源: 让 Claude 了解 Redash 中有哪些可用的数据分析内容。
- 指示 Claude 使用 Redash 工具: 例如,您可以要求 Claude 执行某个 Redash 查询并获取结果,或者获取特定仪表板的详细信息。
- 利用 Redash 数据增强对话: 将 Redash 的数据分析结果融入到与 LLM 的对话中,以实现更智能的数据驱动交互。
注意: 请确保您的 Redash 实例可访问,并且提供的 API 密钥具有足够的权限。
信息
分类
商业系统