@lightdash-tools/mcp 0.1.0 → 0.1.2

package/README.md

@@ -2,6 +2,20 @@
 
 MCP server for Lightdash: exposes projects, charts, dashboards, spaces, users, and groups as tools. Uses `@lightdash-tools/client` for all API access.
 
+## Installation
+
+You can run the MCP server using `npx`:
+
+```bash
+npx @lightdash-tools/mcp
+```
+
+Or install it globally:
+
+```bash
+npm install -g @lightdash-tools/mcp
+```
+
 ## Transports
 
 - **Stdio** — for local use (e.g. Claude Desktop, IDE). One process per client.
@@ -24,20 +38,24 @@ MCP server for Lightdash: exposes projects, charts, dashboards, spaces, users, a
 
 ### Stdio (local)
 
+For use with Claude Desktop or IDEs, use `npx`:
+
+```bash
+npx @lightdash-tools/mcp
+```
+
+Or if installed globally:
+
 ```bash
-pnpm build
-pnpm start
-# or: node dist/index.js
+lightdash-mcp
 ```
 
-Use with Claude Desktop or an IDE by configuring the MCP server command (e.g. `node` with path to `dist/index.js`). Logging goes to stderr only; stdout is JSON-RPC.
+Logging goes to stderr only; stdout is JSON-RPC.
 
 ### Streamable HTTP (remote)
 
 ```bash
-pnpm build
-pnpm start:http
-# or: node dist/http.js
+npx @lightdash-tools/mcp --http
 ```
 
 The server listens on `http://localhost:3100` (or `MCP_HTTP_PORT`). MCP endpoint: `POST/GET/DELETE /mcp`. Sessions are created on first `initialize`; subsequent requests must include the `Mcp-Session-Id` header returned by the server.
@@ -46,8 +64,32 @@ With auth disabled (default), any client can call the endpoint. With `MCP_AUTH_E
 
 ## Tools
 
-Same set in both modes: `list_projects`, `get_project`, `list_charts`, `list_dashboards`, `list_spaces`, `get_space`, `list_organization_members`, `get_member`, `delete_member`, `list_groups`, `get_group`.
+Same set in both modes: `list_projects`, `get_project`, `list_explores`, `get_explore`, `list_charts`, `list_charts_as_code`, `upsert_chart_as_code`, `list_dashboards`, `list_spaces`, `get_space`, `list_organization_members`, `get_member`, `delete_member`, `list_groups`, `get_group`, `compile_query`.
 
 ### Destructive tools
 
 Tools with `destructiveHint: true` (e.g. `delete_member`) perform irreversible or high-impact actions. MCP clients should show a warning and/or require user confirmation before executing them. AI agents should ask the user for explicit confirmation before calling such tools.
+
+## Testing
+
+This package includes unit tests and integration tests. Integration tests run against a real Lightdash API and are only executed if the required environment variables are set.
+
+### Running unit tests
+
+```bash
+pnpm test
+```
+
+### Running integration tests
+
+To run tests against a real Lightdash instance, provide your credentials:
+
+```bash
+LIGHTDASH_URL=https://app.lightdash.cloud LIGHTDASH_API_KEY=your_api_key pnpm test
+```
+
+The integration tests will automatically detect these environment variables and run additional scenarios, such as verifying authentication and tool execution against the live API.
+
+## License
+
+Apache-2.0

package/dist/bin.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+/**
+ * MCP server CLI entrypoint.
+ */
+declare const args: string[];

package/dist/bin.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * MCP server CLI entrypoint.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+const args = process.argv.slice(2);
+if (args.includes('--http')) {
+    void Promise.resolve().then(() => __importStar(require('./http.js')));
+}
+else {
+    void Promise.resolve().then(() => __importStar(require('./index.js')));
+}

package/dist/index.integration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.integration.test.js

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
+const index_js_1 = require("@modelcontextprotocol/sdk/client/index.js");
+const inMemory_js_1 = require("@modelcontextprotocol/sdk/inMemory.js");
+const config_1 = require("./config");
+const tools_1 = require("./tools");
+const shared_1 = require("./tools/shared");
+const hasCredentials = !!process.env.LIGHTDASH_API_KEY && !!process.env.LIGHTDASH_URL;
+vitest_1.describe.runIf(hasCredentials)('MCP Integration (Real API)', () => {
+    (0, vitest_1.it)('should authenticate and fetch current organization', () => __awaiter(void 0, void 0, void 0, function* () {
+        const client = (0, config_1.getClient)();
+        // getCurrentOrganization is a better test for connectivity
+        const org = yield client.v1.organizations.getCurrentOrganization();
+        (0, vitest_1.expect)(org).toBeDefined();
+        (0, vitest_1.expect)(org.organizationUuid).toBeDefined();
+        (0, vitest_1.expect)(org.name).toBeDefined();
+        console.error(`Authenticated to organization: ${org.name}`);
+    }));
+    (0, vitest_1.it)('should execute list_projects tool with real API', () => __awaiter(void 0, void 0, void 0, function* () {
+        const client = (0, config_1.getClient)();
+        const server = new mcp_js_1.McpServer({ name: 'test-server', version: '1.0.0' });
+        (0, tools_1.registerTools)(server, client);
+        const [serverTransport, clientTransport] = inMemory_js_1.InMemoryTransport.createLinkedPair();
+        yield server.connect(serverTransport);
+        const mcpClient = new index_js_1.Client({ name: 'test-client', version: '1.0.0' }, { capabilities: {} });
+        yield mcpClient.connect(clientTransport);
+        // Call the tool through the MCP client
+        const result = yield mcpClient.callTool({
+            name: shared_1.TOOL_PREFIX + 'list_projects',
+            arguments: {},
+        });
+        if (result.isError) {
+            console.error('Tool execution failed:', result.content);
+        }
+        (0, vitest_1.expect)(result).toBeDefined();
+        (0, vitest_1.expect)(result.isError).toBeFalsy();
+        (0, vitest_1.expect)(Array.isArray(result.content)).toBe(true);
+        const content = result.content;
+        const textContent = content[0];
+        if (textContent && 'text' in textContent) {
+            (0, vitest_1.expect)(typeof textContent.text).toBe('string');
+            console.error(`Tool list_projects output: ${textContent.text.slice(0, 100)}...`);
+        }
+        yield mcpClient.close();
+        yield server.close();
+    }));
+});

package/dist/tools/shared.d.ts

@@ -10,6 +10,7 @@ export type TextContent = {
         type: 'text';
         text: string;
     }>;
+    isError?: boolean;
 };
 /** Tool handler type used to avoid deep instantiation with SDK/Zod. Accepts (args, extra) for SDK compatibility. */
 export type ToolHandler = (args: unknown, extra?: unknown) => Promise<TextContent>;

package/dist/tools/shared.js

@@ -62,7 +62,7 @@ function wrapTool(client, fn) {
         }
         catch (err) {
             const text = (0, errors_js_1.toMcpErrorMessage)(err);
-            return { content: [{ type: 'text', text }] };
+            return { content: [{ type: 'text', text }], isError: true };
         }
     });
 }

package/package.json

@@ -1,16 +1,19 @@
 {
   "name": "@lightdash-tools/mcp",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "MCP server and utilities for Lightdash AI.",
   "keywords": [],
-  "license": "ISC",
+  "license": "Apache-2.0",
   "author": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "lightdash-mcp": "./dist/bin.js"
+  },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.26.0",
     "zod": "^4.3.6",
-    "@lightdash-tools/client": "0.1.0"
+    "@lightdash-tools/client": "0.1.2"
   },
   "devDependencies": {
     "@types/node": "^25.2.3"

package/src/bin.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+/**
+ * MCP server CLI entrypoint.
+ */
+
+const args = process.argv.slice(2);
+
+if (args.includes('--http')) {
+  void import('./http.js');
+} else {
+  void import('./index.js');
+}

package/src/index.integration.test.ts

@@ -0,0 +1,57 @@
+import { describe, it, expect } from 'vitest';
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+import { InMemoryTransport } from '@modelcontextprotocol/sdk/inMemory.js';
+import { getClient } from './config';
+import { registerTools } from './tools';
+import { TOOL_PREFIX } from './tools/shared';
+
+const hasCredentials = !!process.env.LIGHTDASH_API_KEY && !!process.env.LIGHTDASH_URL;
+
+describe.runIf(hasCredentials)('MCP Integration (Real API)', () => {
+  it('should authenticate and fetch current organization', async () => {
+    const client = getClient();
+    // getCurrentOrganization is a better test for connectivity
+    const org = await client.v1.organizations.getCurrentOrganization();
+    expect(org).toBeDefined();
+    expect(org.organizationUuid).toBeDefined();
+    expect(org.name).toBeDefined();
+    console.error(`Authenticated to organization: ${org.name}`);
+  });
+
+  it('should execute list_projects tool with real API', async () => {
+    const client = getClient();
+    const server = new McpServer({ name: 'test-server', version: '1.0.0' });
+    registerTools(server, client);
+
+    const [serverTransport, clientTransport] = InMemoryTransport.createLinkedPair();
+
+    await server.connect(serverTransport);
+
+    const mcpClient = new Client({ name: 'test-client', version: '1.0.0' }, { capabilities: {} });
+    await mcpClient.connect(clientTransport);
+
+    // Call the tool through the MCP client
+    const result = await mcpClient.callTool({
+      name: TOOL_PREFIX + 'list_projects',
+      arguments: {},
+    });
+
+    if (result.isError) {
+      console.error('Tool execution failed:', result.content);
+    }
+    expect(result).toBeDefined();
+    expect(result.isError).toBeFalsy();
+    expect(Array.isArray(result.content)).toBe(true);
+    const content = result.content as { text: string }[];
+
+    const textContent = content[0];
+    if (textContent && 'text' in textContent) {
+      expect(typeof textContent.text).toBe('string');
+      console.error(`Tool list_projects output: ${textContent.text.slice(0, 100)}...`);
+    }
+
+    await mcpClient.close();
+    await server.close();
+  });
+});

package/src/tools/shared.ts

@@ -11,6 +11,7 @@ export const TOOL_PREFIX = 'lightdash_tools__';
 
 export type TextContent = {
   content: Array<{ type: 'text'; text: string }>;
+  isError?: boolean;
 };
 
 /** Tool handler type used to avoid deep instantiation with SDK/Zod. Accepts (args, extra) for SDK compatibility. */
@@ -95,7 +96,7 @@ export function wrapTool<T>(
       return await handler(args as T);
     } catch (err) {
       const text = toMcpErrorMessage(err);
-      return { content: [{ type: 'text', text }] };
+      return { content: [{ type: 'text', text }], isError: true };
     }
   };
 }