mcp-quickbase 2.2.0 → 2.3.0
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.
|
@@ -13,6 +13,16 @@ export interface OrderBy {
|
|
|
13
13
|
*/
|
|
14
14
|
order: "ASC" | "DESC";
|
|
15
15
|
}
|
|
16
|
+
export interface GroupBy {
|
|
17
|
+
/**
|
|
18
|
+
* Field ID to group by
|
|
19
|
+
*/
|
|
20
|
+
fieldId: number;
|
|
21
|
+
/**
|
|
22
|
+
* Grouping strategy
|
|
23
|
+
*/
|
|
24
|
+
grouping: "equal-values" | "first-word" | "first-letter" | "1000000" | "100000" | "10000" | "1000" | "100" | "10" | "1" | ".1" | ".01" | ".001";
|
|
25
|
+
}
|
|
16
26
|
/**
|
|
17
27
|
* Parameters for query_records tool
|
|
18
28
|
*/
|
|
@@ -33,6 +43,10 @@ export interface QueryRecordsParams {
|
|
|
33
43
|
* Fields to order by
|
|
34
44
|
*/
|
|
35
45
|
orderBy?: OrderBy[];
|
|
46
|
+
/**
|
|
47
|
+
* Fields to group results by for server-side aggregation
|
|
48
|
+
*/
|
|
49
|
+
groupBy?: GroupBy[];
|
|
36
50
|
/**
|
|
37
51
|
* Maximum number of records to return
|
|
38
52
|
*/
|
|
@@ -131,6 +145,25 @@ export declare class QueryRecordsTool extends BaseTool<QueryRecordsParams, Query
|
|
|
131
145
|
};
|
|
132
146
|
};
|
|
133
147
|
};
|
|
148
|
+
groupBy: {
|
|
149
|
+
type: string;
|
|
150
|
+
description: string;
|
|
151
|
+
items: {
|
|
152
|
+
type: string;
|
|
153
|
+
properties: {
|
|
154
|
+
fieldId: {
|
|
155
|
+
type: string;
|
|
156
|
+
description: string;
|
|
157
|
+
};
|
|
158
|
+
grouping: {
|
|
159
|
+
type: string;
|
|
160
|
+
description: string;
|
|
161
|
+
enum: string[];
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
required: string[];
|
|
165
|
+
};
|
|
166
|
+
};
|
|
134
167
|
max_records: {
|
|
135
168
|
type: string;
|
|
136
169
|
description: string;
|
|
@@ -15,7 +15,7 @@ class QueryRecordsTool extends base_1.BaseTool {
|
|
|
15
15
|
constructor(client) {
|
|
16
16
|
super(client);
|
|
17
17
|
this.name = "query_records";
|
|
18
|
-
this.description = "Executes a query against a Quickbase table with optional pagination";
|
|
18
|
+
this.description = "Executes a query against a Quickbase table with optional pagination and server-side field grouping";
|
|
19
19
|
/**
|
|
20
20
|
* Parameter schema for query_records
|
|
21
21
|
*/
|
|
@@ -53,6 +53,39 @@ class QueryRecordsTool extends base_1.BaseTool {
|
|
|
53
53
|
},
|
|
54
54
|
},
|
|
55
55
|
},
|
|
56
|
+
groupBy: {
|
|
57
|
+
type: "array",
|
|
58
|
+
description: "Fields to group results by for server-side aggregation. Use this instead of paginating large tables for counts or summaries - returns only the grouped results (e.g., 5-10 rows for a status count on a 1M+ record table) instead of individual records.",
|
|
59
|
+
items: {
|
|
60
|
+
type: "object",
|
|
61
|
+
properties: {
|
|
62
|
+
fieldId: {
|
|
63
|
+
type: "number",
|
|
64
|
+
description: "The field ID to group by",
|
|
65
|
+
},
|
|
66
|
+
grouping: {
|
|
67
|
+
type: "string",
|
|
68
|
+
description: "The grouping strategy to apply",
|
|
69
|
+
enum: [
|
|
70
|
+
"equal-values",
|
|
71
|
+
"first-word",
|
|
72
|
+
"first-letter",
|
|
73
|
+
"1000000",
|
|
74
|
+
"100000",
|
|
75
|
+
"10000",
|
|
76
|
+
"1000",
|
|
77
|
+
"100",
|
|
78
|
+
"10",
|
|
79
|
+
"1",
|
|
80
|
+
".1",
|
|
81
|
+
".01",
|
|
82
|
+
".001",
|
|
83
|
+
],
|
|
84
|
+
},
|
|
85
|
+
},
|
|
86
|
+
required: ["fieldId", "grouping"],
|
|
87
|
+
},
|
|
88
|
+
},
|
|
56
89
|
max_records: {
|
|
57
90
|
type: "number",
|
|
58
91
|
description: "Maximum number of records to return when paginating (default: 1000)",
|
|
@@ -79,11 +112,12 @@ class QueryRecordsTool extends base_1.BaseTool {
|
|
|
79
112
|
* @returns Queried records
|
|
80
113
|
*/
|
|
81
114
|
async run(params) {
|
|
82
|
-
const { table_id, where, select, orderBy, max_records = 1000, skip = 0, paginate = false, options, } = params;
|
|
115
|
+
const { table_id, where, select, orderBy, groupBy, max_records = 1000, skip = 0, paginate = false, options, } = params;
|
|
83
116
|
logger.info("Querying records from Quickbase table", {
|
|
84
117
|
tableId: table_id,
|
|
85
118
|
maxRecords: max_records,
|
|
86
119
|
pagination: paginate ? "enabled" : "disabled",
|
|
120
|
+
hasGroupBy: groupBy && groupBy.length > 0 ? true : undefined,
|
|
87
121
|
});
|
|
88
122
|
// Prepare the query body
|
|
89
123
|
const body = {
|
|
@@ -101,6 +135,10 @@ class QueryRecordsTool extends base_1.BaseTool {
|
|
|
101
135
|
if (orderBy && orderBy.length > 0) {
|
|
102
136
|
body.sortBy = orderBy;
|
|
103
137
|
}
|
|
138
|
+
// Add grouping if provided
|
|
139
|
+
if (groupBy && groupBy.length > 0) {
|
|
140
|
+
body.groupBy = groupBy;
|
|
141
|
+
}
|
|
104
142
|
// Add pagination
|
|
105
143
|
const limit = parseInt(max_records.toString(), 10);
|
|
106
144
|
body.options = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query_records.js","sourceRoot":"","sources":["../../../src/tools/records/query_records.ts"],"names":[],"mappings":";;;AAAA,kCAAmC;AAEnC,+CAAkD;AAElD,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,kBAAkB,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"query_records.js","sourceRoot":"","sources":["../../../src/tools/records/query_records.ts"],"names":[],"mappings":";;;AAAA,kCAAmC;AAEnC,+CAAkD;AAElD,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,kBAAkB,CAAC,CAAC;AA6IhD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,eAGrC;IAkGC;;;OAGG;IACH,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAC;QAtGT,SAAI,GAAG,eAAe,CAAC;QACvB,gBAAW,GAChB,oGAAoG,CAAC;QAEvG;;WAEG;QACI,gBAAW,GAAG;YACnB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,+BAA+B;iBAC7C;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,gBAAgB;iBAC9B;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,OAAO;oBACb,WAAW,EAAE,kBAAkB;oBAC/B,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,WAAW,EAAE,4BAA4B;oBACzC,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,OAAO,EAAE;gCACP,IAAI,EAAE,QAAQ;6BACf;4BACD,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;6BACtB;yBACF;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,WAAW,EACT,0PAA0P;oBAC5P,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,OAAO,EAAE;gCACP,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,0BAA0B;6BACxC;4BACD,QAAQ,EAAE;gCACR,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,gCAAgC;gCAC7C,IAAI,EAAE;oCACJ,cAAc;oCACd,YAAY;oCACZ,cAAc;oCACd,SAAS;oCACT,QAAQ;oCACR,OAAO;oCACP,MAAM;oCACN,KAAK;oCACL,IAAI;oCACJ,GAAG;oCACH,IAAI;oCACJ,KAAK;oCACL,MAAM;iCACP;6BACF;yBACF;wBACD,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC;qBAClC;iBACF;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,qEAAqE;iBACxE;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2BAA2B;iBACzC;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,SAAS;oBACf,WAAW,EACT,kEAAkE;iBACrE;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,uDAAuD;iBACrE;aACF;YACD,QAAQ,EAAE,CAAC,UAAU,CAAC;SACvB,CAAC;IAQF,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,GAAG,CAAC,MAA0B;QAC5C,MAAM,EACJ,QAAQ,EACR,KAAK,EACL,MAAM,EACN,OAAO,EACP,OAAO,EACP,WAAW,GAAG,IAAI,EAClB,IAAI,GAAG,CAAC,EACR,QAAQ,GAAG,KAAK,EAChB,OAAO,GACR,GAAG,MAAM,CAAC;QAEX,MAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE;YACnD,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,WAAW;YACvB,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU;YAC7C,UAAU,EAAE,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAC7D,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAwB;YAChC,IAAI,EAAE,QAAQ;SACf,CAAC;QAEF,+BAA+B;QAC/B,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACrB,CAAC;QAED,gCAAgC;QAChC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;QAED,0BAA0B;QAC1B,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACxB,CAAC;QAED,2BAA2B;QAC3B,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QAED,iBAAiB;QACjB,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG;YACb,IAAI;YACJ,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,8CAA8C;YAC1E,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;SACnB,CAAC;QAEF,oBAAoB;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YACzC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gBAAgB;YACtB,IAAI;SACL,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE;gBACtC,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAC;YACH,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,yBAAyB,CAAC,CAAC;QACxE,CAAC;QAED,qCAAqC;QACrC,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA+B,CAAC;QAEtD,gCAAgC;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;QAE1B,sCAAsC;QACtC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;YACvC,CAAC,CAAE,IAAI,CAAC,MAAoC;YAC5C,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,QAAQ,GAAG;YACf,MAAM;YACN,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,OAAO,CAAC,MAAM;YAC1B,IAAI;SACL,CAAC;QAEF,6DAA6D;QAC7D,IAAI,UAAU,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;QAC9B,IAAI,OAAO,GAAG,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAElD,IAAI,QAAQ,IAAI,OAAO,IAAI,UAAU,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE;gBACtC,cAAc,EAAE,UAAU,CAAC,MAAM;gBACjC,KAAK;aACN,CAAC,CAAC;YAEH,IAAI,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;YACxC,IAAI,cAAc,GAAG,CAAC,CAAC;YACvB,MAAM,aAAa,GAAG,GAAG,CAAC,CAAC,0CAA0C;YACrE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,oBAAoB;YAE7C,0EAA0E;YAC1E,OAAO,OAAO,IAAI,UAAU,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;gBAC5C,yBAAyB;gBACzB,cAAc,EAAE,CAAC;gBACjB,IAAI,cAAc,GAAG,aAAa,EAAE,CAAC;oBACnC,MAAM,CAAC,KAAK,CAAC,iDAAiD,EAAE;wBAC9D,cAAc;wBACd,aAAa;wBACb,YAAY,EAAE,UAAU,CAAC,MAAM;qBAChC,CAAC,CAAC;oBACH,MAAM;gBACR,CAAC;gBAED,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC;oBACvC,MAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE;wBAC3D,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;wBACnC,SAAS;wBACT,YAAY,EAAE,UAAU,CAAC,MAAM;qBAChC,CAAC,CAAC;oBACH,MAAM;gBACR,CAAC;gBACD,4BAA4B;gBAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;gBAChC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAE7D,0BAA0B;gBAC1B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;oBAC7C,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,gBAAgB;oBACtB,IAAI;iBACL,CAAC,CAAC;gBAEH,IAAI,CAAC,YAAY,CAAC,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;oBAChD,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE;wBACjD,KAAK,EAAE,YAAY,CAAC,KAAK;wBACzB,OAAO,EAAE,QAAQ;wBACjB,IAAI,EAAE,WAAW;qBAClB,CAAC,CAAC;oBACH,MAAM;gBACR,CAAC;gBAED,gDAAgD;gBAChD,IACE,OAAO,YAAY,CAAC,IAAI,KAAK,QAAQ;oBACrC,YAAY,CAAC,IAAI,KAAK,IAAI,EAC1B,CAAC;oBACD,MAAM,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;oBACnE,MAAM;gBACR,CAAC;gBAED,MAAM,QAAQ,GAAG,YAAY,CAAC,IAA+B,CAAC;gBAE9D,qCAAqC;gBACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClC,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrE,MAAM;gBACR,CAAC;gBAED,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAElC,0EAA0E;gBAC1E,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC7B,MAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;oBAC9D,OAAO,GAAG,KAAK,CAAC;oBAChB,MAAM;gBACR,CAAC;gBAED,2DAA2D;gBAC3D,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC;gBAErC,0EAA0E;gBAC1E,IAAI,UAAU,GAAG,WAAW,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;oBAC5C,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;oBACvD,MAAM,cAAc,GAAG,KAAK,GAAG,UAAU,CAAC;oBAC1C,UAAU,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;oBACtE,qEAAqE;oBACrE,OAAO,GAAG,IAAI,CAAC;oBACf,MAAM;gBACR,CAAC;gBAED,qCAAqC;gBACrC,UAAU,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,WAAW,CAAC,CAAC;gBAE7C,yDAAyD;gBACzD,MAAM,YAAY,GAAG,WAAW,CAAC;gBACjC,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC;gBAElC,qDAAqD;gBACrD,IAAI,WAAW,IAAI,YAAY,EAAE,CAAC;oBAChC,MAAM,CAAC,KAAK,CACV,6DAA6D,EAC7D;wBACE,YAAY;wBACZ,WAAW;wBACX,eAAe,EAAE,WAAW,CAAC,MAAM;qBACpC,CACF,CAAC;oBACF,MAAM;gBACR,CAAC;gBAED,OAAO;oBACL,WAAW,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC;gBAEvE,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE;oBACzC,UAAU,EAAE,WAAW,CAAC,MAAM;oBAC9B,YAAY,EAAE,UAAU,CAAC,MAAM;oBAC/B,KAAK;oBACL,WAAW;oBACX,OAAO;iBACR,CAAC,CAAC;YACL,CAAC;YAED,8CAA8C;YAC9C,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC;QAC1C,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,aAAa,UAAU,CAAC,MAAM,qBAAqB,EAAE;YAC/D,OAAO,EAAE,QAAQ;YACjB,OAAO;SACR,CAAC,CAAC;QAEH,OAAO;YACL,OAAO,EAAE,UAAU;YACnB,YAAY,EAAE,UAAU,CAAC,MAAM;YAC/B,OAAO;YACP,QAAQ;SACT,CAAC;IACJ,CAAC;CACF;AAjWD,4CAiWC"}
|