使用说明

项目简介

lightdash-mcp-server 是一个 MCP (Model Context Protocol) 服务器，它充当 LLM 客户端和 Lightdash 数据分析平台之间的桥梁。通过这个服务器，LLM 应用可以利用 MCP 协议的标准方式，安全、便捷地访问 Lightdash 中存储的数据和分析能力。

主要功能点

数据访问工具: 提供一系列工具，允许 LLM 客户端查询和获取 Lightdash 项目、空间、图表、仪表盘、指标等信息。
Lightdash 数据集成: 将 Lightdash 的数据分析能力通过 MCP 协议暴露出来，使得 LLM 可以利用 Lightdash 强大的数据洞察能力。
标准化接口: 遵循 MCP 协议，提供标准的 JSON-RPC 接口，方便各种 LLM 客户端集成。

安装步骤

安装 npm 包:

npm install lightdash-mcp-server

服务器配置

MCP 客户端需要配置以下信息以连接到 lightdash-mcp-server 服务器。配置为 JSON 格式，通常在客户端的配置文件中设置。

{
  "serverName": "lightdash-mcp-server",
  "command": "node",
  "args": [
    "--import",
    "./ts-node-loader.js",
    "./src/index.ts"
  ],
  "env": {
    "LIGHTDASH_API_KEY": "<your_lightdash_api_key>",
    "LIGHTDASH_API_URL": "https://app.lightdash.cloud/api/v1"  // 可选，如果使用自托管 Lightdash 实例，请修改为您的 Lightdash API URL
  }
}

参数说明:

'serverName': 服务器名称，可以自定义。
'command': 运行服务器的命令，这里使用 'node'。
'args': 传递给 'node' 命令的参数，
- '--import ./ts-node-loader.js': 使用 'ts-node-loader.js' 来加载 TypeScript 代码，以便直接运行 TypeScript 服务器代码。
- './src/index.ts': 服务器入口文件路径。
'env': 环境变量，用于配置 Lightdash API 密钥和 URL。
- 'LIGHTDASH_API_KEY': 必填，您的 Lightdash API 密钥。请在 Lightdash 控制台中获取。
- 'LIGHTDASH_API_URL': 可选，Lightdash API 的 URL。默认为 'https://app.lightdash.cloud/api/v1'。如果您使用自托管的 Lightdash 实例，请修改为您的实例 URL。

注意:

请确保 MCP 客户端能够找到 'ts-node-loader.js' 和 'src/index.ts' 文件，可能需要根据实际客户端的工作目录调整 'args' 中的路径。
建议将 Lightdash API 密钥等敏感信息配置在环境变量中，保证安全性。

基本使用方法

配置环境变量: 创建 '.env' 文件，并填入您的 Lightdash API 密钥和 URL (如果需要自定义):

LIGHTDASH_API_KEY=your_api_key
LIGHTDASH_API_URL=https://app.lightdash.cloud/api/v1

启动 MCP 服务器: 在项目根目录下，运行以下命令启动服务器：
```
npx lightdash-mcp-server
```
或者直接使用 'node --import ts-node-loader.js src/index.ts' 命令。
使用 MCP 客户端连接: 配置您的 MCP 客户端，使用上述 服务器配置 中的信息连接到 lightdash-mcp-server。
调用工具: 通过 MCP 客户端，您可以调用服务器提供的工具，例如 'list_projects'、'list_spaces' 等，来访问 Lightdash 的数据。具体工具列表和使用方法请参考项目 'README.md' 文件或服务器返回的工具列表。示例代码可以参考仓库中的 'examples' 目录。

关键词