metabase-agent-mcp-server 0.1.0

package/.dockerignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+.git
+*.md

package/.env.example

@@ -0,0 +1,5 @@
+# Base URL of your Metabase instance (e.g. https://metabase.example.com)
+METABASE_URL=
+
+# API key created in Admin > Settings > Authentication > API Keys
+METABASE_API_KEY=

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "all",
+  "semi": true,
+  "singleQuote": false
+}

package/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:20-slim AS build
+
+WORKDIR /app
+COPY package.json package-lock.json* ./
+RUN npm ci
+COPY tsconfig.json ./
+COPY src ./src
+RUN npm run build
+
+FROM node:20-slim
+
+WORKDIR /app
+COPY package.json package-lock.json* ./
+RUN npm ci --omit=dev
+COPY --from=build /app/dist ./dist
+
+ENTRYPOINT ["node", "dist/index.js"]

package/README.md

@@ -0,0 +1,106 @@
+# Metabase Agent MCP Server
+
+An MCP (Model Context Protocol) server that exposes [Metabase's Agent API](https://www.metabase.com/docs/latest/ai/agent-api) as tools for AI assistants like Claude, LibreChat, or any MCP-compatible client.
+
+The Agent API is a versioned REST API for building headless, agentic BI applications on top of Metabase's semantic layer. This MCP server wraps the Agent API v1 endpoints so that LLMs can discover tables and metrics, inspect fields, and run queries — all scoped to the permissions of the configured API key.
+
+## Prerequisites
+
+- **Metabase** v0.59+ with a Pro/Enterprise license (the Agent API is a paid feature)
+- A **Metabase API key** created in Admin > Settings > Authentication > API Keys
+- **Node.js** 20+ (for local usage) or **Docker**
+
+## Configuration
+
+The server reads two required environment variables:
+
+| Variable           | Description                                       |
+| ------------------ | ------------------------------------------------- |
+| `METABASE_URL`     | Base URL of your Metabase instance (e.g. `https://metabase.example.com`) |
+| `METABASE_API_KEY` | API key for authenticating with Metabase           |
+
+### Why API key instead of JWT?
+
+The Metabase Agent API docs recommend JWT for per-user auth scoping. However, MCP clients like Claude Desktop and LibreChat pass static environment variables to servers — they don't support dynamic JWT generation. A Metabase API key provides a simple, static credential that works with any MCP client. The API key's permissions are determined by the Metabase user it was created for.
+
+## Usage
+
+### With Claude Desktop
+
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "metabase": {
+      "command": "node",
+      "args": ["/path/to/metabase-agent-mcp-server/dist/index.js"],
+      "env": {
+        "METABASE_URL": "https://metabase.example.com",
+        "METABASE_API_KEY": "mb_your_api_key_here"
+      }
+    }
+  }
+}
+```
+
+### With LibreChat
+
+Configure in your LibreChat MCP settings:
+
+```yaml
+mcpServers:
+  metabase:
+    command: node
+    args:
+      - /path/to/metabase-agent-mcp-server/dist/index.js
+    env:
+      METABASE_URL: https://metabase.example.com
+      METABASE_API_KEY: mb_your_api_key_here
+```
+
+### With Docker
+
+```bash
+docker build -t metabase-agent-mcp .
+
+docker run -i --rm \
+  -e METABASE_URL=https://metabase.example.com \
+  -e METABASE_API_KEY=mb_your_api_key_here \
+  metabase-agent-mcp
+```
+
+## Available Tools
+
+| Tool               | Description                                                                 |
+| ------------------ | --------------------------------------------------------------------------- |
+| `search`           | Search for tables and metrics (term-based and/or semantic)                  |
+| `get_table`        | Get details for a table: fields, related tables, metrics, measures, segments |
+| `get_metric`       | Get details for a metric: queryable dimensions, segments                    |
+| `get_field_values` | Get statistics and sample values for a table or metric field                |
+| `run_query`        | Construct and execute a query in one step                                   |
+
+### Typical workflow
+
+1. **Search** for relevant tables or metrics using `search`
+2. **Inspect** a table (`get_table`) or metric (`get_metric`) to see its fields and schema
+3. **Explore** field values with `get_field_values` if you need to discover valid filter values
+4. **Query** using `run_query` to get results
+
+## Development
+
+```bash
+npm install
+npm run build
+npm start
+```
+
+Run tests:
+
+```bash
+npm test
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,252 @@
+#!/usr/bin/env node
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { z } from "zod";
+import { MetabaseClient } from "./metabase-client.js";
+const METABASE_URL = process.env.METABASE_URL;
+const METABASE_API_KEY = process.env.METABASE_API_KEY;
+if (!METABASE_URL || !METABASE_API_KEY) {
+    console.error("Required environment variables: METABASE_URL, METABASE_API_KEY");
+    process.exit(1);
+}
+const client = new MetabaseClient({
+    url: METABASE_URL,
+    apiKey: METABASE_API_KEY,
+});
+const server = new McpServer({
+    name: "metabase-agent",
+    version: "0.1.0",
+});
+async function handleToolCall(fn, format) {
+    try {
+        const result = await fn();
+        return { content: [{ type: "text", text: format(result) }] };
+    }
+    catch (err) {
+        const msg = err instanceof Error ? err.message : String(err);
+        return { content: [{ type: "text", text: msg }], isError: true };
+    }
+}
+const json = (v) => JSON.stringify(v, null, 2);
+// ---------------------------------------------------------------------------
+// Tool: search
+// ---------------------------------------------------------------------------
+server.tool("search", "Search for tables and metrics in Metabase. Supports term-based and semantic search queries. Results are ranked using Reciprocal Rank Fusion when both query types are provided.", {
+    term_queries: z
+        .array(z.string().min(1))
+        .optional()
+        .describe("Term-based search queries"),
+    semantic_queries: z
+        .array(z.string().min(1))
+        .optional()
+        .describe("Semantic search queries"),
+}, async ({ term_queries, semantic_queries }) => handleToolCall(() => client.search({ term_queries, semantic_queries }), json));
+// ---------------------------------------------------------------------------
+// Tool: get_table
+// ---------------------------------------------------------------------------
+server.tool("get_table", "Get details for a table including fields, related tables, metrics, measures, and segments.", {
+    id: z.number().int().min(1).describe("Table ID"),
+    with_fields: z
+        .boolean()
+        .optional()
+        .describe("Include table fields (default: true)"),
+    with_field_values: z
+        .boolean()
+        .optional()
+        .describe("Include sample field values (default: true)"),
+    with_related_tables: z
+        .boolean()
+        .optional()
+        .describe("Include related tables via FK (default: true)"),
+    with_metrics: z
+        .boolean()
+        .optional()
+        .describe("Include metrics associated with this table (default: true)"),
+    with_measures: z
+        .boolean()
+        .optional()
+        .describe("Include reusable measure definitions (default: false)"),
+    with_segments: z
+        .boolean()
+        .optional()
+        .describe("Include predefined filter segments (default: false)"),
+}, async (args) => handleToolCall(() => client.getTable(args.id, {
+    withFields: args.with_fields,
+    withFieldValues: args.with_field_values,
+    withRelatedTables: args.with_related_tables,
+    withMetrics: args.with_metrics,
+    withMeasures: args.with_measures,
+    withSegments: args.with_segments,
+}), json));
+// ---------------------------------------------------------------------------
+// Tool: get_metric
+// ---------------------------------------------------------------------------
+server.tool("get_metric", "Get details for a metric including its queryable dimensions and segments.", {
+    id: z.number().int().min(1).describe("Metric ID"),
+    with_queryable_dimensions: z
+        .boolean()
+        .optional()
+        .describe("Include queryable dimension fields (default: true)"),
+    with_field_values: z
+        .boolean()
+        .optional()
+        .describe("Include sample field values for dimensions (default: true)"),
+    with_default_temporal_breakout: z
+        .boolean()
+        .optional()
+        .describe("Include default time dimension for temporal breakouts (default: true)"),
+    with_segments: z
+        .boolean()
+        .optional()
+        .describe("Include predefined filter segments (default: false)"),
+}, async (args) => handleToolCall(() => client.getMetric(args.id, {
+    withQueryableDimensions: args.with_queryable_dimensions,
+    withFieldValues: args.with_field_values,
+    withDefaultTemporalBreakout: args.with_default_temporal_breakout,
+    withSegments: args.with_segments,
+}), json));
+// ---------------------------------------------------------------------------
+// Tool: get_field_values
+// ---------------------------------------------------------------------------
+server.tool("get_field_values", "Get statistics and sample values for a specific field. Useful for understanding data distribution, valid filter values, and field characteristics.", {
+    entity_type: z
+        .enum(["table", "metric"])
+        .describe("Whether the field belongs to a table or metric"),
+    entity_id: z.number().int().min(1).describe("Table or metric ID"),
+    field_id: z
+        .string()
+        .min(1)
+        .describe("Field ID (format: 't<id>-<index>' for table fields, 'c<id>-<index>' for metric fields)"),
+}, async ({ entity_type, entity_id, field_id }) => handleToolCall(() => client.getFieldValues(entity_type, entity_id, field_id), json));
+// ---------------------------------------------------------------------------
+// Shared schemas for query construction
+// ---------------------------------------------------------------------------
+const FilterSchema = z.union([
+    z.object({ segment_id: z.number().int() }).describe("Segment filter"),
+    z
+        .object({
+        field_id: z.string(),
+        operation: z.string(),
+        value: z.any().optional(),
+        values: z.array(z.any()).optional(),
+        bucket: z.string().optional(),
+    })
+        .describe("Field filter"),
+]);
+const GroupBySchema = z.object({
+    field_id: z.string(),
+    field_granularity: z
+        .enum([
+        "minute",
+        "hour",
+        "day",
+        "week",
+        "month",
+        "quarter",
+        "year",
+        "day-of-week",
+    ])
+        .nullable()
+        .optional(),
+});
+const FieldRefSchema = z.object({
+    field_id: z.string(),
+    bucket: z.string().optional(),
+});
+const OrderBySchema = z.object({
+    field: FieldRefSchema,
+    direction: z.enum(["asc", "desc"]),
+});
+const AggregationSchema = z.union([
+    z.object({
+        function: z.literal("count"),
+        sort_order: z.enum(["asc", "desc"]).nullable().optional(),
+    }),
+    z.object({
+        field_id: z.string(),
+        function: z.enum(["avg", "count-distinct", "max", "min", "sum"]),
+        sort_order: z.enum(["asc", "desc"]).nullable().optional(),
+    }),
+    z.object({
+        measure_id: z.number().int(),
+        sort_order: z.enum(["asc", "desc"]).nullable().optional(),
+    }),
+]);
+// ---------------------------------------------------------------------------
+// Tool: run_query
+// ---------------------------------------------------------------------------
+server.tool("run_query", `Construct and execute a query against Metabase, returning results directly.
+
+For tables: supports filters, fields, aggregations, group_by, order_by, limit.
+For metrics: supports filters, group_by (aggregation is defined by the metric).
+
+Provide EITHER table_id OR metric_id, not both.
+Row limits: 2000 for simple queries, 10000 for aggregated queries.`, {
+    table_id: z
+        .number()
+        .int()
+        .min(1)
+        .optional()
+        .describe("Table ID (mutually exclusive with metric_id)"),
+    metric_id: z
+        .number()
+        .int()
+        .min(1)
+        .optional()
+        .describe("Metric ID (mutually exclusive with table_id)"),
+    filters: z
+        .array(FilterSchema)
+        .optional()
+        .describe("Filter conditions to apply"),
+    fields: z
+        .array(FieldRefSchema)
+        .optional()
+        .describe("Specific fields to select (omit for all fields, table queries only)"),
+    aggregations: z
+        .array(AggregationSchema)
+        .optional()
+        .describe("Aggregation functions: count, avg, sum, min, max, count-distinct, or measure_id (table queries only)"),
+    group_by: z
+        .array(GroupBySchema)
+        .optional()
+        .describe("Fields to group by, with optional temporal granularity"),
+    order_by: z
+        .array(OrderBySchema)
+        .optional()
+        .describe("Order by fields. To order by aggregation, use sort_order on the aggregation instead (table queries only)"),
+    limit: z
+        .number()
+        .int()
+        .min(1)
+        .optional()
+        .describe("Maximum rows to return (table queries only)"),
+}, async (args) => {
+    try {
+        const constructed = await client.constructQuery(args);
+        const result = await client.executeQuery({ query: constructed.query });
+        return {
+            content: [{ type: "text", text: json(result) }],
+            ...(result.status === "failed" && { isError: true }),
+        };
+    }
+    catch (err) {
+        const msg = err instanceof Error ? err.message : String(err);
+        return {
+            content: [{ type: "text", text: msg }],
+            isError: true,
+        };
+    }
+});
+// ---------------------------------------------------------------------------
+// Start the server
+// ---------------------------------------------------------------------------
+async function main() {
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+    console.error("Metabase Agent MCP server running on stdio");
+}
+main().catch((err) => {
+    console.error("Fatal error:", err);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;AAC9C,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;AAEtD,IAAI,CAAC,YAAY,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACvC,OAAO,CAAC,KAAK,CACX,gEAAgE,CACjE,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC;IAChC,GAAG,EAAE,YAAY;IACjB,MAAM,EAAE,gBAAgB;CACzB,CAAC,CAAC;AAEH,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IAC3B,IAAI,EAAE,gBAAgB;IACtB,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAWH,KAAK,UAAU,cAAc,CAC3B,EAAoB,EACpB,MAA6B;IAE7B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;QAC1B,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7D,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACnE,CAAC;AACH,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAExD,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAC9E,MAAM,CAAC,IAAI,CACT,QAAQ,EACR,iLAAiL,EACjL;IACE,YAAY,EAAE,CAAC;SACZ,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,2BAA2B,CAAC;IACxC,gBAAgB,EAAE,CAAC;SAChB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CAAC,yBAAyB,CAAC;CACvC,EACD,KAAK,EAAE,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAC3C,cAAc,CACZ,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC,EACvD,IAAI,CACL,CACJ,CAAC;AAEF,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAC9E,MAAM,CAAC,IAAI,CACT,WAAW,EACX,4FAA4F,EAC5F;IACE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;IAChD,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC;IACnD,iBAAiB,EAAE,CAAC;SACjB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,6CAA6C,CAAC;IAC1D,mBAAmB,EAAE,CAAC;SACnB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,+CAA+C,CAAC;IAC5D,YAAY,EAAE,CAAC;SACZ,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,4DAA4D,CAAC;IACzE,aAAa,EAAE,CAAC;SACb,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,aAAa,EAAE,CAAC;SACb,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,qDAAqD,CAAC;CACnE,EACD,KAAK,EAAE,IAAI,EAAE,EAAE,CACb,cAAc,CACZ,GAAG,EAAE,CACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE;IACvB,UAAU,EAAE,IAAI,CAAC,WAAW;IAC5B,eAAe,EAAE,IAAI,CAAC,iBAAiB;IACvC,iBAAiB,EAAE,IAAI,CAAC,mBAAmB;IAC3C,WAAW,EAAE,IAAI,CAAC,YAAY;IAC9B,YAAY,EAAE,IAAI,CAAC,aAAa;IAChC,YAAY,EAAE,IAAI,CAAC,aAAa;CACjC,CAAC,EACJ,IAAI,CACL,CACJ,CAAC;AAEF,8EAA8E;AAC9E,mBAAmB;AACnB,8EAA8E;AAC9E,MAAM,CAAC,IAAI,CACT,YAAY,EACZ,2EAA2E,EAC3E;IACE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;IACjD,yBAAyB,EAAE,CAAC;SACzB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,oDAAoD,CAAC;IACjE,iBAAiB,EAAE,CAAC;SACjB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,4DAA4D,CAAC;IACzE,8BAA8B,EAAE,CAAC;SAC9B,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,uEAAuE,CACxE;IACH,aAAa,EAAE,CAAC;SACb,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,qDAAqD,CAAC;CACnE,EACD,KAAK,EAAE,IAAI,EAAE,EAAE,CACb,cAAc,CACZ,GAAG,EAAE,CACH,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE;IACxB,uBAAuB,EAAE,IAAI,CAAC,yBAAyB;IACvD,eAAe,EAAE,IAAI,CAAC,iBAAiB;IACvC,2BAA2B,EAAE,IAAI,CAAC,8BAA8B;IAChE,YAAY,EAAE,IAAI,CAAC,aAAa;CACjC,CAAC,EACJ,IAAI,CACL,CACJ,CAAC;AAEF,8EAA8E;AAC9E,yBAAyB;AACzB,8EAA8E;AAC9E,MAAM,CAAC,IAAI,CACT,kBAAkB,EAClB,oJAAoJ,EACpJ;IACE,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;SACzB,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IACjE,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,wFAAwF,CACzF;CACJ,EACD,KAAK,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,CAC7C,cAAc,CACZ,GAAG,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC,EAC7D,IAAI,CACL,CACJ,CAAC;AAEF,8EAA8E;AAC9E,wCAAwC;AACxC,8EAA8E;AAE9E,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC;IAC3B,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACrE,CAAC;SACE,MAAM,CAAC;QACN,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;QACrB,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACzB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;QACnC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;SACD,QAAQ,CAAC,cAAc,CAAC;CAC5B,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,iBAAiB,EAAE,CAAC;SACjB,IAAI,CAAC;QACJ,QAAQ;QACR,MAAM;QACN,KAAK;QACL,MAAM;QACN,OAAO;QACP,SAAS;QACT,MAAM;QACN,aAAa;KACd,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,EAAE;CACd,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,KAAK,EAAE,cAAc;IACrB,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;CACnC,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC;IAChC,CAAC,CAAC,MAAM,CAAC;QACP,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC5B,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KAC1D,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAChE,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KAC1D,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QAC5B,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KAC1D,CAAC;CACH,CAAC,CAAC;AAEH,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAC9E,MAAM,CAAC,IAAI,CACT,WAAW,EACX;;;;;;mEAMiE,EACjE;IACE,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,YAAY,CAAC;SACnB,QAAQ,EAAE;SACV,QAAQ,CAAC,4BAA4B,CAAC;IACzC,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,cAAc,CAAC;SACrB,QAAQ,EAAE;SACV,QAAQ,CACP,qEAAqE,CACtE;IACH,YAAY,EAAE,CAAC;SACZ,KAAK,CAAC,iBAAiB,CAAC;SACxB,QAAQ,EAAE;SACV,QAAQ,CACP,sGAAsG,CACvG;IACH,QAAQ,EAAE,CAAC;SACR,KAAK,CAAC,aAAa,CAAC;SACpB,QAAQ,EAAE;SACV,QAAQ,CAAC,wDAAwD,CAAC;IACrE,QAAQ,EAAE,CAAC;SACR,KAAK,CAAC,aAAa,CAAC;SACpB,QAAQ,EAAE;SACV,QAAQ,CACP,0GAA0G,CAC3G;IACH,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,6CAA6C,CAAC;CAC3D,EACD,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,cAAc,CAC7C,IAAmD,CACpD,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC;QACvE,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACxD,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;SACrD,CAAC;IACJ,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7D,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;YAC/C,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;AACH,CAAC,CACF,CAAC;AAEF,8EAA8E;AAC9E,mBAAmB;AACnB,8EAA8E;AAC9E,KAAK,UAAU,IAAI;IACjB,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAC9D,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;IACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/metabase-client.d.ts

@@ -0,0 +1,203 @@
+export interface MetabaseClientConfig {
+    url: string;
+    apiKey: string;
+    timeoutMs?: number;
+}
+export declare class MetabaseClient {
+    private baseUrl;
+    private apiKey;
+    private timeoutMs;
+    constructor(config: MetabaseClientConfig);
+    private request;
+    search(params: {
+        term_queries?: string[];
+        semantic_queries?: string[];
+    }): Promise<SearchResponse>;
+    getTable(id: number, opts?: {
+        withFields?: boolean;
+        withFieldValues?: boolean;
+        withRelatedTables?: boolean;
+        withMetrics?: boolean;
+        withMeasures?: boolean;
+        withSegments?: boolean;
+    }): Promise<Table>;
+    getFieldValues(entityType: "table" | "metric", entityId: number, fieldId: string): Promise<FieldValues>;
+    getMetric(id: number, opts?: {
+        withQueryableDimensions?: boolean;
+        withFieldValues?: boolean;
+        withDefaultTemporalBreakout?: boolean;
+        withSegments?: boolean;
+    }): Promise<Metric>;
+    constructQuery(params: ConstructQueryRequest): Promise<ConstructQueryResponse>;
+    executeQuery(params: ExecuteQueryRequest): Promise<ExecuteQueryResponse>;
+}
+export interface SearchResponse {
+    data: SearchResultItem[];
+    total_count: number;
+}
+export interface SearchResultItem {
+    id: number;
+    type: "table" | "metric";
+    name: string;
+    display_name?: string | null;
+    description?: string | null;
+    database_id?: number | null;
+    database_schema?: string | null;
+    verified?: boolean | null;
+    created_at?: string | null;
+    updated_at?: string | null;
+}
+export interface Field {
+    field_id: string;
+    name: string;
+    type?: "boolean" | "date" | "datetime" | "time" | "number" | "string" | null;
+    description?: string | null;
+    database_type?: string | null;
+    semantic_type?: string | null;
+    field_values?: unknown[] | null;
+}
+export interface Segment {
+    id: number;
+    name: string;
+    description?: string | null;
+    display_name?: string | null;
+}
+export interface Measure {
+    id: number;
+    name: string;
+    description?: string | null;
+    display_name?: string | null;
+}
+export interface MetricSummary {
+    id: number;
+    type: "metric";
+    name: string;
+    description?: string | null;
+    default_time_dimension_field_id?: string | null;
+}
+export interface RelatedTable {
+    id: number;
+    type: "table";
+    name: string;
+    display_name?: string | null;
+    description?: string | null;
+    database_id?: number | null;
+    database_engine?: string | null;
+    database_schema?: string | null;
+    related_by?: string | null;
+    fields?: Field[] | null;
+}
+export interface Table {
+    id: number;
+    type: "table" | "metric";
+    name: string;
+    display_name: string;
+    description?: string | null;
+    database_id: number;
+    database_engine: string;
+    database_schema?: string | null;
+    fields: Field[];
+    related_tables?: RelatedTable[] | null;
+    metrics?: MetricSummary[] | null;
+    measures?: Measure[] | null;
+    segments?: Segment[] | null;
+}
+export interface Metric {
+    id: number;
+    type: "metric";
+    name: string;
+    description?: string | null;
+    verified?: boolean | null;
+    default_time_dimension_field_id?: string | null;
+    queryable_dimensions?: Field[] | null;
+    segments?: Segment[] | null;
+}
+export interface Statistics {
+    distinct_count?: number | null;
+    percent_null?: number | null;
+    min?: number | null;
+    max?: number | null;
+    avg?: number | null;
+    sd?: number | null;
+    q1?: number | null;
+    q3?: number | null;
+    earliest?: string | null;
+    latest?: string | null;
+    average_length?: number | null;
+    percent_email?: number | null;
+    percent_url?: number | null;
+    percent_state?: number | null;
+    percent_json?: number | null;
+}
+export interface FieldValues {
+    field_id?: string | null;
+    values?: unknown[] | null;
+    statistics?: Statistics | null;
+}
+export type Filter = {
+    segment_id: number;
+} | {
+    field_id: string;
+    operation: string;
+    value?: unknown;
+    values?: unknown[];
+    bucket?: string;
+};
+export interface GroupBy {
+    field_id: string;
+    field_granularity?: string | null;
+}
+export interface FieldRef {
+    field_id: string;
+    bucket?: string;
+}
+export interface OrderBy {
+    field: FieldRef;
+    direction: "asc" | "desc";
+}
+export type Aggregation = {
+    function: "count";
+    sort_order?: "asc" | "desc" | null;
+} | {
+    field_id: string;
+    function: "avg" | "count-distinct" | "max" | "min" | "sum";
+    sort_order?: "asc" | "desc" | null;
+} | {
+    measure_id: number;
+    sort_order?: "asc" | "desc" | null;
+};
+export type ConstructQueryRequest = {
+    table_id: number;
+    filters?: Filter[] | null;
+    fields?: FieldRef[] | null;
+    aggregations?: Aggregation[] | null;
+    group_by?: GroupBy[] | null;
+    order_by?: OrderBy[] | null;
+    limit?: number | null;
+} | {
+    metric_id: number;
+    filters?: Filter[] | null;
+    group_by?: GroupBy[] | null;
+};
+export interface ConstructQueryResponse {
+    query: string;
+}
+export interface ColumnMetadata {
+    name: string;
+    base_type: string;
+    display_name: string;
+    effective_type?: string | null;
+}
+export interface ExecuteQueryRequest {
+    query: string;
+}
+export interface ExecuteQueryResponse {
+    status: "completed" | "failed";
+    data?: {
+        cols: ColumnMetadata[];
+        rows: unknown[][];
+    };
+    row_count?: number;
+    running_time?: number;
+    error?: string;
+}