lightdash-mcp-server

lightdash-mcp-server

Lightdash にアクセスする MCP(Model Context Protocol) サーバーです。

このサーバーは Lightdash の API への 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 は 2 つのトランスポートモードをサポートしています: Stdio（デフォルト）と HTTP です。

Stdio トランスポート（デフォルト）

1. MCP サーバーを起動します:

npx lightdash-mcp-server

2. MCP 設定 JSON を編集します:

...
    "lightdash": {
      "command": "npx",
      "args": [
        "-y",
        "lightdash-mcp-server"
      ],
      "env": {
        "LIGHTDASH_API_KEY": "<your PAT>",
        "LIGHTDASH_API_URL": "https://<your base url>"
      }
    },
...

HTTP トランスポート（Streamable HTTP）

1. HTTP モードで MCP サーバーを起動します:

npx lightdash-mcp-server -port 8080

これにより StreamableHTTPServerTransport を使用してサーバーが起動し、http://localhost:8080/mcp で HTTP 経由でアクセスできるようになります。

2. HTTP 経由で接続するように MCP クライアントを設定します:

Claude Desktop およびその他の MCP クライアントの場合:

command と args の代わりに url フィールドを使用するように、MCP 設定 JSON を編集します:

...
    "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 クライアントの設定を通じて渡すことができないため、サーバーが実行されている環境で設定されていることを確認してください。

HTTP サーバーにプログラムから接続する完全な例については、examples/list_spaces_http.ts を参照してください。

開発

利用可能なスクリプト

• npm run dev - ホットリロードを備えた開発モードでサーバーを起動します（stdio トランスポート）
• npm run dev:http - ポート 8080 で HTTP トランスポートを使用して開発モードでサーバーを起動します
• 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. プルリクエストを作成します