@514labs/moose-lib 0.6.437 → 0.6.438

package/dist/index.d.mts

@@ -677,6 +677,7 @@ interface DimensionDef<TModel = any, TKey extends keyof TModel = keyof TModel> {
     column?: TKey;
     expression?: Sql;
     as?: string;
+    description?: string;
 }
 /**
  * Metric definition — an aggregate or computed value.
@@ -691,6 +692,7 @@ interface DimensionDef<TModel = any, TKey extends keyof TModel = keyof TModel> {
 interface MetricDef {
     agg: Sql;
     as?: string;
+    description?: string;
 }
 /**
  * Column definition for detail (non-aggregated) queries.
@@ -752,6 +754,7 @@ interface ModelFilterDef<TModel, TKey extends keyof TModel = keyof TModel> {
     inputType?: FilterInputTypeHint;
     /** When true, this filter's `eq` param is required in MCP tool schemas */
     required?: true;
+    description?: string;
 }
 /** Extract string keys from a record type */
 type Names<T> = Extract<keyof T, string>;
@@ -935,8 +938,6 @@ interface QueryModel<TTable, TMetrics extends Record<string, MetricDef>, TDimens
     readonly dimensions?: TDimensions;
     readonly metrics?: TMetrics;
     readonly columns?: TColumns;
-    readonly dimensionNames: readonly string[];
-    readonly metricNames: readonly string[];
     readonly columnNames: readonly string[];
     /** Type inference helpers (similar to Drizzle's $inferSelect pattern). */
     readonly $inferDimensions: Names<TDimensions>;
@@ -1117,6 +1118,7 @@ interface QueryModelFilter {
     operators: readonly string[];
     inputType?: FilterInputTypeHint;
     required?: true;
+    description?: string;
 }
 /**
  * Minimal model interface consumed by createModelTool / registerModelTools.
@@ -1139,8 +1141,12 @@ interface QueryModelBase {
     };
     readonly filters: Record<string, QueryModelFilter>;
     readonly sortable: readonly string[];
-    readonly dimensionNames: readonly string[];
-    readonly metricNames: readonly string[];
+    readonly dimensions?: Record<string, {
+        description?: string;
+    }>;
+    readonly metrics?: Record<string, {
+        description?: string;
+    }>;
     readonly columnNames: readonly string[];
     toSql(request: Record<string, unknown>): Sql;
 }

package/dist/index.d.ts

@@ -677,6 +677,7 @@ interface DimensionDef<TModel = any, TKey extends keyof TModel = keyof TModel> {
     column?: TKey;
     expression?: Sql;
     as?: string;
+    description?: string;
 }
 /**
  * Metric definition — an aggregate or computed value.
@@ -691,6 +692,7 @@ interface DimensionDef<TModel = any, TKey extends keyof TModel = keyof TModel> {
 interface MetricDef {
     agg: Sql;
     as?: string;
+    description?: string;
 }
 /**
  * Column definition for detail (non-aggregated) queries.
@@ -752,6 +754,7 @@ interface ModelFilterDef<TModel, TKey extends keyof TModel = keyof TModel> {
     inputType?: FilterInputTypeHint;
     /** When true, this filter's `eq` param is required in MCP tool schemas */
     required?: true;
+    description?: string;
 }
 /** Extract string keys from a record type */
 type Names<T> = Extract<keyof T, string>;
@@ -935,8 +938,6 @@ interface QueryModel<TTable, TMetrics extends Record<string, MetricDef>, TDimens
     readonly dimensions?: TDimensions;
     readonly metrics?: TMetrics;
     readonly columns?: TColumns;
-    readonly dimensionNames: readonly string[];
-    readonly metricNames: readonly string[];
     readonly columnNames: readonly string[];
     /** Type inference helpers (similar to Drizzle's $inferSelect pattern). */
     readonly $inferDimensions: Names<TDimensions>;
@@ -1117,6 +1118,7 @@ interface QueryModelFilter {
     operators: readonly string[];
     inputType?: FilterInputTypeHint;
     required?: true;
+    description?: string;
 }
 /**
  * Minimal model interface consumed by createModelTool / registerModelTools.
@@ -1139,8 +1141,12 @@ interface QueryModelBase {
     };
     readonly filters: Record<string, QueryModelFilter>;
     readonly sortable: readonly string[];
-    readonly dimensionNames: readonly string[];
-    readonly metricNames: readonly string[];
+    readonly dimensions?: Record<string, {
+        description?: string;
+    }>;
+    readonly metrics?: Record<string, {
+        description?: string;
+    }>;
     readonly columnNames: readonly string[];
     toSql(request: Record<string, unknown>): Sql;
 }

package/dist/index.js

@@ -4579,8 +4579,6 @@ function defineQueryModel(config) {
     dimensions,
     metrics,
     columns: columnDefs,
-    dimensionNames,
-    metricNames,
     columnNames,
     query: async (request, client) => {
       const result = await client.execute(toSql(request));
@@ -4668,6 +4666,14 @@ function camelToSnake(s) {
 function titleFromName(name) {
   return name.replace(/^query_/, "Query ").replace(/^list_/, "List ").replace(/_/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
 }
+function buildEnumDescription(metadata) {
+  const entries = Object.entries(metadata);
+  if (entries.length === 0) return void 0;
+  const lines = entries.map(([name, def]) => {
+    return def.description ? `- ${name}: ${def.description}` : `- ${name}`;
+  });
+  return lines.join("\n");
+}
 function zodBaseType(inputType) {
   if (inputType === "number") return import_zod.z.number();
   return import_zod.z.string();
@@ -4705,13 +4711,19 @@ function createModelTool(model, options = {}) {
   const requiredSet = new Set(requiredFilters);
   const schema = {};
   const filterParamMap = {};
-  if (model.dimensionNames.length > 0) {
-    const names = model.dimensionNames;
-    schema.dimensions = import_zod.z.array(import_zod.z.enum(names)).optional();
-  }
-  if (model.metricNames.length > 0) {
-    const names = model.metricNames;
-    schema.metrics = import_zod.z.array(import_zod.z.enum(names)).optional();
+  const dimensionNames = Object.keys(model.dimensions ?? {});
+  if (dimensionNames.length > 0) {
+    const names = dimensionNames;
+    const desc = buildEnumDescription(model.dimensions);
+    const dimSchema = import_zod.z.array(import_zod.z.enum(names)).optional();
+    schema.dimensions = desc ? dimSchema.describe(desc) : dimSchema;
+  }
+  const metricNames = Object.keys(model.metrics ?? {});
+  if (metricNames.length > 0) {
+    const names = metricNames;
+    const desc = buildEnumDescription(model.metrics);
+    const metSchema = import_zod.z.array(import_zod.z.enum(names)).optional();
+    schema.metrics = desc ? metSchema.describe(desc) : metSchema;
   }
   if (model.columnNames.length > 0) {
     const names = model.columnNames;
@@ -4735,9 +4747,10 @@ function createModelTool(model, options = {}) {
         paramType = baseType;
       }
       if (requiredSet.has(filterName) && op === "eq") {
-        schema[paramName] = paramType;
+        schema[paramName] = filterDef.description ? paramType.describe(filterDef.description) : paramType;
       } else {
-        schema[paramName] = paramType.optional();
+        const opt = paramType.optional();
+        schema[paramName] = filterDef.description ? opt.describe(filterDef.description) : opt;
       }
       filterParamMap[paramName] = { filterName, op };
     }
@@ -4745,10 +4758,10 @@ function createModelTool(model, options = {}) {
   schema.limit = import_zod.z.number().min(1).max(maxLimit).default(defaultLimit).optional();
   function buildRequest(params) {
     const request = {};
-    if (model.dimensionNames.length > 0) {
+    if (dimensionNames.length > 0) {
       request.dimensions = params.dimensions ?? mergedDefaults.dimensions;
     }
-    if (model.metricNames.length > 0) {
+    if (metricNames.length > 0) {
       request.metrics = params.metrics ?? mergedDefaults.metrics;
     }
     if (model.columnNames.length > 0) {