lightdash-mcp-server

一个访问 Lightdash 的 MCP（模型上下文协议） 服务器。

该服务器提供了与 MCP 兼容的访问方式，使 AI 助手能够通过标准化接口与您的 Lightdash 数据进行交互。

功能

可用工具：

• list_projects - 列出 Lightdash 组织中的所有项目
• get_project - 获取特定项目的详细信息
• list_spaces - 列出项目中的所有空间
• list_charts - 列出项目中的所有图表
• list_dashboards - 列出项目中的所有仪表板
• get_custom_metrics - 获取项目的自定义指标
• get_catalog - 获取项目的目录
• get_metrics_catalog - 获取项目的指标目录
• get_charts_as_code - 获取项目的图表代码
• get_dashboards_as_code - 获取项目的仪表板代码

快速开始

安装

通过 Smithery 安装

通过 Smithery自动为 Claude Desktop 安装 Lightdash MCP Server：

npx -y @smithery/cli install lightdash-mcp-server --client claude

手动安装

npm install lightdash-mcp-server

配置

• LIGHTDASH_API_KEY: 您的 Lightdash PAT
• LIGHTDASH_API_URL: API 基础 URL

使用

lightdash-mcp-server 支持两种传输模式：Stdio（默认）和 HTTP。

Stdio 传输（默认）

1. 启动 MCP 服务器：

npx lightdash-mcp-server

2. 编辑您的 MCP 配置 json：

...
    "lightdash": {
      "command": "npx",
      "args": [
        "-y",
        "lightdash-mcp-server"
      ],
      "env": {
        "LIGHTDASH_API_KEY": "<您的 PAT>",
        "LIGHTDASH_API_URL": "https://<您的基础 URL>"
      }
    },
...

HTTP 传输（可流式 HTTP）

1. 以 HTTP 模式启动 MCP 服务器：

npx lightdash-mcp-server -port 8080

这将使用 StreamableHTTPServerTransport 启动服务器，使其可以通过 HTTP 访问 http://localhost:8080/mcp。

2. 配置您的 MCP 客户端以通过 HTTP 连接：

对于 Claude Desktop 和其他 MCP 客户端：

编辑您的 MCP 配置 json，使用 url 字段代替 command 和 args：

...
    "lightdash": {
      "url": "http://localhost:8080/mcp"
    },
...

对于编程访问：

使用可流式 HTTP 客户端传输：

import { Client } from '@modelcontextprotocol/sdk/client/index.js';
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js';

const client = new Client({
  name: 'my-client',
  version: '1.0.0'
}, {
  capabilities: {}
});

const transport = new StreamableHTTPClientTransport(
  new URL('http://localhost:8080/mcp')
);

await client.connect(transport);

注意： 使用 HTTP 模式时，请确保在服务器运行的环境中设置了环境变量 LIGHTDASH_API_KEY 和 LIGHTDASH_API_URL，因为它们无法通过 MCP 客户端配置传递。

查看 examples/list_spaces_http.ts 以获取通过编程方式连接到 HTTP 服务器的完整示例。

开发

可用脚本

• npm run dev - 以开发模式启动服务器，支持热重载（stdio 传输）
• npm run dev:http - 以开发模式启动服务器，支持 HTTP 传输，端口为 8080
• npm run build - 构建生产环境项目
• npm run start - 启动生产服务器
• npm run lint - 运行代码检查（ESLint 和 Prettier）
• npm run fix - 自动修复代码检查问题
• npm run examples - 运行示例脚本

贡献

1. 分叉仓库
2. 创建您的功能分支
3. 运行测试和代码检查：npm run lint
4. 提交您的更改
5. 推送分支
6. 创建拉取请求