@hypequery/mcp 0.1.0

package/dist/tools/query-metric.js

@@ -0,0 +1,63 @@
+/**
+ * Query Metric Tool
+ *
+ * Executes a metric query with optional dimensions, filters, grain, and sorting.
+ */
+export async function queryMetricTool(datasets, executor, args) {
+    // Parse and validate args
+    const validatedArgs = args;
+    const { dataset: datasetName, metric: metricName, dimensions, filters, grain, orderBy, limit } = validatedArgs;
+    if (!datasetName) {
+        throw new Error('dataset parameter is required');
+    }
+    if (!metricName) {
+        throw new Error('metric parameter is required');
+    }
+    const dataset = datasets[datasetName];
+    if (!dataset) {
+        throw new Error(`Dataset not found: ${datasetName}`);
+    }
+    // Get the metric from the dataset
+    const metric = dataset[metricName] || dataset.metrics?.[metricName];
+    if (!metric) {
+        throw new Error(`Metric not found: ${metricName} in dataset ${datasetName}`);
+    }
+    // Build the query with proper types
+    const query = {
+        dimensions: dimensions || [],
+        filters: filters || [],
+        orderBy: orderBy || [],
+    };
+    if (grain) {
+        query.by = grain;
+    }
+    // Apply limit with maximum cap
+    const MAX_LIMIT = 10000;
+    if (limit !== undefined) {
+        query.limit = Math.min(limit, MAX_LIMIT);
+    }
+    // Execute the query
+    const result = await executor.run(metric, query, {
+        runtime: {
+            builderFactory: executor.getBuilderFactory(),
+            tenant: undefined,
+        },
+    });
+    // Format the response with proper types
+    const response = {
+        data: result.data,
+        meta: {
+            sql: result.meta?.sql,
+            timingMs: result.meta?.timingMs,
+            rowCount: result.data.length,
+        },
+    };
+    return {
+        content: [
+            {
+                type: 'text',
+                text: JSON.stringify(response, null, 2),
+            },
+        ],
+    };
+}

package/dist/types.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Type definitions for MCP Server
+ */
+import type { MetricFilter, TimeGrain, MetricOrderBy } from '@hypequery/datasets';
+/**
+ * Registry of datasets - maps dataset names to dataset instances
+ * Using flexible type to accommodate actual dataset structure
+ */
+export type DatasetRegistry = Record<string, Record<string, unknown>>;
+/**
+ * Arguments for query_metric tool
+ */
+export interface QueryMetricArgs {
+    dataset: string;
+    metric: string;
+    dimensions?: string[];
+    filters?: MetricFilter[];
+    grain?: TimeGrain;
+    orderBy?: MetricOrderBy[];
+    limit?: number;
+}
+/**
+ * Arguments for query_dataset tool
+ */
+export interface QueryDatasetArgs {
+    dataset: string;
+    dimensions?: string[];
+    metrics?: string[];
+    filters?: MetricFilter[];
+    grain?: TimeGrain;
+    orderBy?: MetricOrderBy[];
+    limit?: number;
+}
+/**
+ * Arguments for get_dataset_schema tool
+ */
+export interface GetDatasetSchemaArgs {
+    dataset: string;
+}
+/**
+ * MCP tool response format
+ * Matches the MCP SDK CallToolResult type
+ */
+export interface MCPToolResponse {
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    isError?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * Dataset schema response structure
+ */
+export interface DatasetSchema {
+    name: string;
+    description: string;
+    source: string;
+    timeKey: string | null;
+    tenantKey: string | null;
+    dimensions: Record<string, DimensionSchema>;
+    metrics: Record<string, MetricSchema>;
+    relationships: Record<string, RelationshipSchema>;
+}
+/**
+ * Dimension schema in response
+ */
+export interface DimensionSchema {
+    type: string;
+    column: string;
+    label: string;
+    description: string;
+    examples: string[];
+}
+/**
+ * Metric schema in response
+ */
+export interface MetricSchema {
+    type: string;
+    aggregation: string;
+    label: string;
+    description: string;
+    format: string | null;
+}
+/**
+ * Relationship schema in response
+ */
+export interface RelationshipSchema {
+    type: string;
+    target: string;
+    description: string;
+}
+/**
+ * Dataset list item
+ */
+export interface DatasetListItem {
+    name: string;
+    description: string;
+    dimensionCount: number;
+    metricCount: number;
+}
+/**
+ * Datasets list response
+ */
+export interface DatasetsListResponse {
+    datasets: DatasetListItem[];
+    total: number;
+}
+/**
+ * Query result metadata
+ */
+export interface QueryResultMeta {
+    sql?: string;
+    timingMs?: number;
+    rowCount: number;
+}
+/**
+ * Query result response
+ */
+export interface QueryResultResponse {
+    data: Record<string, unknown>[];
+    meta: QueryResultMeta;
+}
+/**
+ * Constants
+ */
+export declare const MAX_QUERY_LIMIT = 10000;
+export declare const DEFAULT_QUERY_LIMIT = 100;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,YAAY,EACZ,SAAS,EACT,aAAa,EACd,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC5C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACtC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAChC,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,QAAQ,CAAC;AACrC,eAAO,MAAM,mBAAmB,MAAM,CAAC"}

package/dist/types.js

@@ -0,0 +1,8 @@
+/**
+ * Type definitions for MCP Server
+ */
+/**
+ * Constants
+ */
+export const MAX_QUERY_LIMIT = 10000;
+export const DEFAULT_QUERY_LIMIT = 100;

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hypequery/mcp",
+  "version": "0.1.0",
+  "description": "Model Context Protocol (MCP) server for Hypequery semantic layer",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "hypequery-mcp": "./dist/bin.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "zod": "^3.23.8",
+    "@hypequery/datasets": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.30",
+    "typescript": "^5.7.3",
+    "vitest": "^2.1.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hypequery/hypequery.git"
+  },
+  "homepage": "https://hypequery.com",
+  "bugs": {
+    "url": "https://github.com/hypequery/hypequery/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "dev": "tsc --project tsconfig.json --watch",
+    "test": "npm run test:types && npm run test:unit",
+    "test:unit": "vitest run",
+    "test:types": "tsc --project tsconfig.json --noEmit",
+    "start": "node dist/bin.js"
+  }
+}