@hypequery/mcp 0.8.1 → 0.8.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.type-test.js +17 -0
- package/dist/tools/args.d.ts +19 -13
- package/dist/tools/args.d.ts.map +1 -1
- package/dist/tools/args.js +5 -2
- package/dist/tools/query-dataset.d.ts.map +1 -1
- package/dist/tools/query-dataset.js +4 -1
- package/dist/tools/query-metric.d.ts.map +1 -1
- package/dist/tools/query-metric.js +4 -1
- package/dist/tools/tool-manifest.d.ts +1 -1
- package/dist/tools/tool-manifest.d.ts.map +1 -1
- package/dist/tools/tool-manifest.js +2 -1
- package/dist/tools/utils/legacy-agent-catalog.d.ts.map +1 -1
- package/dist/tools/utils/legacy-agent-catalog.js +2 -1
- package/dist/types.d.ts +11 -7
- package/dist/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +3 -3
package/dist/api.type-test.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { expectTypeOf, it } from 'vitest';
|
|
2
|
+
import { dataset, dimension, measure } from '@hypequery/datasets';
|
|
2
3
|
import { HypequeryMCPExecutor, HypequeryMCPProtocolServer, HypequeryMCPServer, MCPToolError, connectMCPServerStdio, createMCPExecutor, createMCPProtocolServer, createMCPServer, startStdioMCPServer, } from './index.js';
|
|
3
4
|
it('exports the transport-neutral and backwards-compatible MCP APIs', () => {
|
|
4
5
|
expectTypeOf(HypequeryMCPExecutor).toBeConstructibleWith({});
|
|
@@ -12,3 +13,19 @@ it('exports the transport-neutral and backwards-compatible MCP APIs', () => {
|
|
|
12
13
|
expectTypeOf(new MCPToolError('MCP_UNAUTHORIZED', 'Forbidden').code)
|
|
13
14
|
.toMatchTypeOf();
|
|
14
15
|
});
|
|
16
|
+
it('accepts segments in the exported query argument types', () => {
|
|
17
|
+
expectTypeOf().toEqualTypeOf();
|
|
18
|
+
expectTypeOf().toEqualTypeOf();
|
|
19
|
+
const _orders = dataset('orders', {
|
|
20
|
+
source: 'orders',
|
|
21
|
+
dimensions: { status: dimension.string() },
|
|
22
|
+
measures: { revenue: measure.sum('amount') },
|
|
23
|
+
segments: { paid: { filters: [{ field: 'status', operator: 'eq', value: 'paid' }] } },
|
|
24
|
+
});
|
|
25
|
+
expectTypeOf()
|
|
26
|
+
.toEqualTypeOf();
|
|
27
|
+
expectTypeOf()
|
|
28
|
+
.toEqualTypeOf();
|
|
29
|
+
expectTypeOf().toEqualTypeOf();
|
|
30
|
+
expectTypeOf().toEqualTypeOf();
|
|
31
|
+
});
|
package/dist/tools/args.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { type MetricFilter } from '@hypequery/datasets';
|
|
2
|
+
import { type MetricFilter, type TimeGrain } from '@hypequery/datasets';
|
|
3
3
|
export declare const queryMetricArgsSchema: z.ZodObject<{
|
|
4
4
|
dimensions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
5
5
|
filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
@@ -15,7 +15,8 @@ export declare const queryMetricArgsSchema: z.ZodObject<{
|
|
|
15
15
|
operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "notIn" | "between" | "like";
|
|
16
16
|
value?: any;
|
|
17
17
|
}>, "many">>;
|
|
18
|
-
|
|
18
|
+
segments: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
19
|
+
grain: z.ZodOptional<z.ZodEnum<[TimeGrain, ...TimeGrain[]]>>;
|
|
19
20
|
orderBy: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
20
21
|
field: z.ZodString;
|
|
21
22
|
direction: z.ZodEnum<["asc", "desc"]>;
|
|
@@ -32,15 +33,16 @@ export declare const queryMetricArgsSchema: z.ZodObject<{
|
|
|
32
33
|
dataset: z.ZodOptional<z.ZodString>;
|
|
33
34
|
metric: z.ZodOptional<z.ZodString>;
|
|
34
35
|
}, "strict", z.ZodTypeAny, {
|
|
36
|
+
dataset?: string | undefined;
|
|
35
37
|
dimensions?: string[] | undefined;
|
|
36
38
|
filters?: {
|
|
37
39
|
field: string;
|
|
38
40
|
operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "notIn" | "between" | "like";
|
|
39
41
|
value?: any;
|
|
40
42
|
}[] | undefined;
|
|
43
|
+
segments?: string[] | undefined;
|
|
41
44
|
metric?: string | undefined;
|
|
42
|
-
|
|
43
|
-
grain?: "day" | "week" | "month" | "quarter" | "year" | undefined;
|
|
45
|
+
grain?: TimeGrain | undefined;
|
|
44
46
|
orderBy?: {
|
|
45
47
|
field: string;
|
|
46
48
|
direction: "asc" | "desc";
|
|
@@ -48,15 +50,16 @@ export declare const queryMetricArgsSchema: z.ZodObject<{
|
|
|
48
50
|
limit?: number | undefined;
|
|
49
51
|
offset?: number | undefined;
|
|
50
52
|
}, {
|
|
53
|
+
dataset?: string | undefined;
|
|
51
54
|
dimensions?: string[] | undefined;
|
|
52
55
|
filters?: {
|
|
53
56
|
field: string;
|
|
54
57
|
operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "notIn" | "between" | "like";
|
|
55
58
|
value?: any;
|
|
56
59
|
}[] | undefined;
|
|
60
|
+
segments?: string[] | undefined;
|
|
57
61
|
metric?: string | undefined;
|
|
58
|
-
|
|
59
|
-
grain?: "day" | "week" | "month" | "quarter" | "year" | undefined;
|
|
62
|
+
grain?: TimeGrain | undefined;
|
|
60
63
|
orderBy?: {
|
|
61
64
|
field: string;
|
|
62
65
|
direction: "asc" | "desc";
|
|
@@ -79,7 +82,8 @@ export declare const queryDatasetArgsSchema: z.ZodObject<{
|
|
|
79
82
|
operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "notIn" | "between" | "like";
|
|
80
83
|
value?: any;
|
|
81
84
|
}>, "many">>;
|
|
82
|
-
|
|
85
|
+
segments: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
86
|
+
grain: z.ZodOptional<z.ZodEnum<[TimeGrain, ...TimeGrain[]]>>;
|
|
83
87
|
orderBy: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
84
88
|
field: z.ZodString;
|
|
85
89
|
direction: z.ZodEnum<["asc", "desc"]>;
|
|
@@ -96,15 +100,16 @@ export declare const queryDatasetArgsSchema: z.ZodObject<{
|
|
|
96
100
|
dataset: z.ZodOptional<z.ZodString>;
|
|
97
101
|
measures: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
98
102
|
}, "strict", z.ZodTypeAny, {
|
|
103
|
+
dataset?: string | undefined;
|
|
99
104
|
dimensions?: string[] | undefined;
|
|
105
|
+
measures?: string[] | undefined;
|
|
100
106
|
filters?: {
|
|
101
107
|
field: string;
|
|
102
108
|
operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "notIn" | "between" | "like";
|
|
103
109
|
value?: any;
|
|
104
110
|
}[] | undefined;
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
grain?: "day" | "week" | "month" | "quarter" | "year" | undefined;
|
|
111
|
+
segments?: string[] | undefined;
|
|
112
|
+
grain?: TimeGrain | undefined;
|
|
108
113
|
orderBy?: {
|
|
109
114
|
field: string;
|
|
110
115
|
direction: "asc" | "desc";
|
|
@@ -112,15 +117,16 @@ export declare const queryDatasetArgsSchema: z.ZodObject<{
|
|
|
112
117
|
limit?: number | undefined;
|
|
113
118
|
offset?: number | undefined;
|
|
114
119
|
}, {
|
|
120
|
+
dataset?: string | undefined;
|
|
115
121
|
dimensions?: string[] | undefined;
|
|
122
|
+
measures?: string[] | undefined;
|
|
116
123
|
filters?: {
|
|
117
124
|
field: string;
|
|
118
125
|
operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "notIn" | "between" | "like";
|
|
119
126
|
value?: any;
|
|
120
127
|
}[] | undefined;
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
grain?: "day" | "week" | "month" | "quarter" | "year" | undefined;
|
|
128
|
+
segments?: string[] | undefined;
|
|
129
|
+
grain?: TimeGrain | undefined;
|
|
124
130
|
orderBy?: {
|
|
125
131
|
field: string;
|
|
126
132
|
direction: "asc" | "desc";
|
package/dist/tools/args.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../../src/tools/args.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,
|
|
1
|
+
{"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../../src/tools/args.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAGL,KAAK,YAAY,EACjB,KAAK,SAAS,EACf,MAAM,qBAAqB,CAAC;AAkC7B,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGhC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AAWH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,CASzF;AAED,wBAAgB,eAAe,CAC7B,OAAO,GAAE,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,CAAM,GAC1F,YAAY,EAAE,CAMhB"}
|
package/dist/tools/args.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { SEMANTIC_FILTER_OPERATORS } from '@hypequery/datasets';
|
|
2
|
+
import { SEMANTIC_FILTER_OPERATORS, SUPPORTED_TIME_GRAINS, } from '@hypequery/datasets';
|
|
3
3
|
import { MCPToolError } from '../errors.js';
|
|
4
4
|
import { MAX_QUERY_DIMENSIONS, MAX_QUERY_FILTERS, MAX_QUERY_LIMIT, MAX_QUERY_MEASURES, MAX_QUERY_OFFSET, MAX_QUERY_ORDER_BY, } from '../types.js';
|
|
5
5
|
const filterSchema = z.object({
|
|
@@ -14,7 +14,10 @@ const orderBySchema = z.object({
|
|
|
14
14
|
const baseQuerySchema = z.object({
|
|
15
15
|
dimensions: z.array(z.string().min(1)).max(MAX_QUERY_DIMENSIONS).optional(),
|
|
16
16
|
filters: z.array(filterSchema).max(MAX_QUERY_FILTERS).optional(),
|
|
17
|
-
|
|
17
|
+
// Each dataset narrows this to the segment names it declares.
|
|
18
|
+
segments: z.array(z.string().min(1)).max(MAX_QUERY_FILTERS).optional(),
|
|
19
|
+
// Each dataset narrows this further through its catalog `supportedGrains`.
|
|
20
|
+
grain: z.enum(SUPPORTED_TIME_GRAINS).optional(),
|
|
18
21
|
orderBy: z.array(orderBySchema).max(MAX_QUERY_ORDER_BY).optional(),
|
|
19
22
|
limit: z.number().int().positive().max(MAX_QUERY_LIMIT).optional(),
|
|
20
23
|
offset: z.number().int().nonnegative().max(MAX_QUERY_OFFSET).optional(),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query-dataset.d.ts","sourceRoot":"","sources":["../../src/tools/query-dataset.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,qBAAqB,CAAC;AAEvE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAYtF,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,aAAa,EACxB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC,
|
|
1
|
+
{"version":3,"file":"query-dataset.d.ts","sourceRoot":"","sources":["../../src/tools/query-dataset.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,qBAAqB,CAAC;AAEvE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAYtF,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,aAAa,EACxB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC,CA+D1B"}
|
|
@@ -13,7 +13,7 @@ import { createMCPToolResponse } from './utils/tool-response.js';
|
|
|
13
13
|
export async function queryDatasetTool(datasets, analytics, args, options = {}) {
|
|
14
14
|
const inputSchema = options.inputSchema ?? buildMCPQuerySchemas(datasets, options.limits).queryDataset;
|
|
15
15
|
const validatedArgs = parseToolArgs(inputSchema, 'query_dataset', args);
|
|
16
|
-
const { dataset: datasetName, dimensions, measures, filters, grain, orderBy } = validatedArgs;
|
|
16
|
+
const { dataset: datasetName, dimensions, measures, filters, segments, grain, orderBy } = validatedArgs;
|
|
17
17
|
if (!datasetName) {
|
|
18
18
|
throw new MCPToolError('MCP_INVALID_ARGUMENTS', 'dataset parameter is required');
|
|
19
19
|
}
|
|
@@ -37,6 +37,9 @@ export async function queryDatasetTool(datasets, analytics, args, options = {})
|
|
|
37
37
|
if (grain) {
|
|
38
38
|
query.by = grain;
|
|
39
39
|
}
|
|
40
|
+
if (segments?.length) {
|
|
41
|
+
query.segments = segments;
|
|
42
|
+
}
|
|
40
43
|
if (pagination.offset !== undefined) {
|
|
41
44
|
query.offset = pagination.offset;
|
|
42
45
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query-metric.d.ts","sourceRoot":"","sources":["../../src/tools/query-metric.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAe,MAAM,qBAAqB,CAAC;AAEtE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAYtF,wBAAsB,eAAe,CACnC,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,aAAa,EACxB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC,
|
|
1
|
+
{"version":3,"file":"query-metric.d.ts","sourceRoot":"","sources":["../../src/tools/query-metric.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAe,MAAM,qBAAqB,CAAC;AAEtE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAYtF,wBAAsB,eAAe,CACnC,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,aAAa,EACxB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC,CAsE1B"}
|
|
@@ -13,7 +13,7 @@ import { createMCPToolResponse } from './utils/tool-response.js';
|
|
|
13
13
|
export async function queryMetricTool(datasets, analytics, args, options = {}) {
|
|
14
14
|
const inputSchema = options.inputSchema ?? buildMCPQuerySchemas(datasets, options.limits).queryMetric;
|
|
15
15
|
const validatedArgs = parseToolArgs(inputSchema, 'query_metric', args);
|
|
16
|
-
const { dataset: datasetName, metric: metricName, dimensions, filters, grain, orderBy } = validatedArgs;
|
|
16
|
+
const { dataset: datasetName, metric: metricName, dimensions, filters, segments, grain, orderBy } = validatedArgs;
|
|
17
17
|
if (!datasetName) {
|
|
18
18
|
throw new MCPToolError('MCP_INVALID_ARGUMENTS', 'dataset parameter is required');
|
|
19
19
|
}
|
|
@@ -41,6 +41,9 @@ export async function queryMetricTool(datasets, analytics, args, options = {}) {
|
|
|
41
41
|
if (grain) {
|
|
42
42
|
query.by = grain;
|
|
43
43
|
}
|
|
44
|
+
if (segments?.length) {
|
|
45
|
+
query.segments = segments;
|
|
46
|
+
}
|
|
44
47
|
if (pagination.offset !== undefined) {
|
|
45
48
|
query.offset = pagination.offset;
|
|
46
49
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type CanonicalSemanticQuerySchemas } from '@hypequery/datasets';
|
|
2
2
|
import type { ListToolsResult } from '@modelcontextprotocol/sdk/types.js';
|
|
3
3
|
export declare const DATASET_LIST_OUTPUT_SCHEMA: {
|
|
4
4
|
[x: string]: unknown;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tool-manifest.d.ts","sourceRoot":"","sources":["../../src/tools/tool-manifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"tool-manifest.d.ts","sourceRoot":"","sources":["../../src/tools/tool-manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,KAAK,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAChG,OAAO,KAAK,EAAE,eAAe,EAAQ,MAAM,oCAAoC,CAAC;AAkEhF,eAAO,MAAM,0BAA0B;;;;;;;2BAsBrC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;2BA0HvC,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;2BAwC9B,CAAC;AAYH,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,6BAA6B,GAC1C,eAAe,CA8CjB"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { SUPPORTED_TIME_GRAINS } from '@hypequery/datasets';
|
|
1
2
|
const semanticMetadataProperties = {
|
|
2
3
|
examples: { type: 'array', items: { type: 'string' } },
|
|
3
4
|
synonyms: { type: 'array', items: { type: 'string' } },
|
|
@@ -99,7 +100,7 @@ export const DATASET_SCHEMA_OUTPUT_SCHEMA = resultSchema({
|
|
|
99
100
|
additionalProperties: false,
|
|
100
101
|
properties: {
|
|
101
102
|
dimensions: { type: 'array', items: { type: 'string' } },
|
|
102
|
-
timeGrain: { type: 'string', enum: [
|
|
103
|
+
timeGrain: { type: 'string', enum: [...SUPPORTED_TIME_GRAINS] },
|
|
103
104
|
},
|
|
104
105
|
},
|
|
105
106
|
timeDimension: { type: ['string', 'null'] },
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"legacy-agent-catalog.d.ts","sourceRoot":"","sources":["../../../src/tools/utils/legacy-agent-catalog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EAQpB,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"legacy-agent-catalog.d.ts","sourceRoot":"","sources":["../../../src/tools/utils/legacy-agent-catalog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EAQpB,MAAM,qBAAqB,CAAC;AAG7B,KAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AA4F7C;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,aAAa,EACpB,QAAQ,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM,GAC/C,mBAAmB,CAuFrB"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import { SUPPORTED_TIME_GRAINS } from '@hypequery/datasets';
|
|
1
2
|
/**
|
|
2
3
|
* Grains the semantic planner can actually execute. A legacy registry is
|
|
3
4
|
* untyped, so anything outside this set is dropped rather than advertised.
|
|
4
5
|
*/
|
|
5
|
-
const TIME_GRAINS = new Set(
|
|
6
|
+
const TIME_GRAINS = new Set(SUPPORTED_TIME_GRAINS);
|
|
6
7
|
function record(value) {
|
|
7
8
|
return value !== null && typeof value === 'object' && !Array.isArray(value)
|
|
8
9
|
? value
|
package/dist/types.d.ts
CHANGED
|
@@ -1,33 +1,37 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Type definitions for MCP Server
|
|
3
3
|
*/
|
|
4
|
-
import type { AgentCatalogDataset, AgentCatalogDimension, AgentCatalogFilter, AgentCatalogMeasure, AgentCatalogMetric, AgentCatalogRelationship, AnyDatasetInstance, MetricFilter, TimeGrain, MetricOrderBy } from '@hypequery/datasets';
|
|
4
|
+
import type { AgentCatalogDataset, AgentCatalogDimension, AgentCatalogFilter, AgentCatalogMeasure, AgentCatalogMetric, AgentCatalogRelationship, AnyDatasetInstance, DatasetSegmentNames, MetricFilter, TimeGrain, MetricOrderBy } from '@hypequery/datasets';
|
|
5
5
|
import type { ZodTypeAny } from 'zod';
|
|
6
6
|
/**
|
|
7
7
|
* Registry of datasets - maps dataset names to dataset instances
|
|
8
8
|
*/
|
|
9
9
|
export type DatasetRegistry = Record<string, AnyDatasetInstance | Record<string, unknown>>;
|
|
10
10
|
/**
|
|
11
|
-
* Arguments for query_metric tool
|
|
11
|
+
* Arguments for query_metric tool. Supply a dataset type to restrict the
|
|
12
|
+
* dataset and segment names; the default supports dynamic registries.
|
|
12
13
|
*/
|
|
13
|
-
export interface QueryMetricArgs {
|
|
14
|
-
dataset:
|
|
14
|
+
export interface QueryMetricArgs<TDataset extends AnyDatasetInstance = AnyDatasetInstance> {
|
|
15
|
+
dataset: TDataset['name'];
|
|
15
16
|
metric: string;
|
|
16
17
|
dimensions?: string[];
|
|
17
18
|
filters?: MetricFilter[];
|
|
19
|
+
segments?: DatasetSegmentNames<TDataset>[];
|
|
18
20
|
grain?: TimeGrain;
|
|
19
21
|
orderBy?: MetricOrderBy[];
|
|
20
22
|
limit?: number;
|
|
21
23
|
offset?: number;
|
|
22
24
|
}
|
|
23
25
|
/**
|
|
24
|
-
* Arguments for query_dataset tool
|
|
26
|
+
* Arguments for query_dataset tool. Supply a dataset type to restrict the
|
|
27
|
+
* dataset and segment names; the default supports dynamic registries.
|
|
25
28
|
*/
|
|
26
|
-
export interface QueryDatasetArgs {
|
|
27
|
-
dataset:
|
|
29
|
+
export interface QueryDatasetArgs<TDataset extends AnyDatasetInstance = AnyDatasetInstance> {
|
|
30
|
+
dataset: TDataset['name'];
|
|
28
31
|
dimensions?: string[];
|
|
29
32
|
measures?: string[];
|
|
30
33
|
filters?: MetricFilter[];
|
|
34
|
+
segments?: DatasetSegmentNames<TDataset>[];
|
|
31
35
|
grain?: TimeGrain;
|
|
32
36
|
orderBy?: MetricOrderBy[];
|
|
33
37
|
limit?: number;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,YAAY,EACZ,SAAS,EACT,aAAa,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,KAAK,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE3F
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,SAAS,EACT,aAAa,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,KAAK,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,WAAW,eAAe,CAAC,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB;IACvF,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC3C,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB;IACxF,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC3C,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,yEAAyE;IACzE,WAAW,CAAC,EAAE,UAAU,CAAC;CAC1B;AAED,6DAA6D;AAC7D,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,kEAAkE;AAClE,MAAM,WAAW,cAAc;IAC7B,iEAAiE;IACjE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,qGAAqG;IACrG,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;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,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,qBAAqB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,wBAAwB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,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;IACjB;;;OAGG;IACH,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;IACF,6CAA6C;IAC7C,KAAK,CAAC,EAAE;QACN,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;QAClC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;CACH;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;AACvC,eAAO,MAAM,gBAAgB,QAAQ,CAAC;AACtC,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AACrC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AACrC,eAAO,MAAM,wBAAwB,QAAS,CAAC;AAC/C,eAAO,MAAM,oBAAoB,SAAU,CAAC;AAC5C,eAAO,MAAM,sBAAsB,UAAY,CAAC;AAChD,eAAO,MAAM,kBAAkB,WAAa,CAAC;AAC7C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AACzC,eAAO,MAAM,kBAAkB,MAAM,CAAC;AACtC,eAAO,MAAM,sBAAsB,SAAU,CAAC;AAC9C,eAAO,MAAM,kBAAkB,UAAY,CAAC"}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const MCP_PACKAGE_VERSION = "0.8.
|
|
1
|
+
export declare const MCP_PACKAGE_VERSION = "0.8.3";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hypequery/mcp",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.3",
|
|
4
4
|
"description": "Governed ClickHouse MCP server for semantic metrics, datasets, Claude, Cursor, and AI agents",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"mcp",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"dist"
|
|
34
34
|
],
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@hypequery/datasets": "^0.
|
|
36
|
+
"@hypequery/datasets": "^0.19.0",
|
|
37
37
|
"@modelcontextprotocol/sdk": "^1.29.0",
|
|
38
38
|
"zod": "^3.23.8"
|
|
39
39
|
},
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"@types/node": "^20.11.30",
|
|
42
42
|
"typescript": "^5.7.3",
|
|
43
43
|
"vitest": "^3.2.6",
|
|
44
|
-
"@hypequery/clickhouse": "2.
|
|
44
|
+
"@hypequery/clickhouse": "2.12.0"
|
|
45
45
|
},
|
|
46
46
|
"repository": {
|
|
47
47
|
"type": "git",
|