@eamonboyle/mssql-mcp 1.1.0 → 1.2.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.
Files changed (129) hide show
  1. package/README.md +134 -22
  2. package/dist/__tests__/ExplainQueryTool.test.d.ts +2 -0
  3. package/dist/__tests__/ExplainQueryTool.test.d.ts.map +1 -0
  4. package/dist/__tests__/ExplainQueryTool.test.js +96 -0
  5. package/dist/__tests__/ExplainQueryTool.test.js.map +1 -0
  6. package/dist/__tests__/config.test.d.ts +2 -0
  7. package/dist/__tests__/config.test.d.ts.map +1 -0
  8. package/dist/__tests__/config.test.js +29 -0
  9. package/dist/__tests__/config.test.js.map +1 -0
  10. package/dist/__tests__/db.test.d.ts +1 -1
  11. package/dist/__tests__/db.test.js +203 -203
  12. package/dist/__tests__/promptRegistry.test.d.ts +2 -0
  13. package/dist/__tests__/promptRegistry.test.d.ts.map +1 -0
  14. package/dist/__tests__/promptRegistry.test.js +40 -0
  15. package/dist/__tests__/promptRegistry.test.js.map +1 -0
  16. package/dist/__tests__/resourceRegistry.test.d.ts +2 -0
  17. package/dist/__tests__/resourceRegistry.test.d.ts.map +1 -0
  18. package/dist/__tests__/resourceRegistry.test.js +40 -0
  19. package/dist/__tests__/resourceRegistry.test.js.map +1 -0
  20. package/dist/__tests__/schema.test.d.ts +2 -0
  21. package/dist/__tests__/schema.test.d.ts.map +1 -0
  22. package/dist/__tests__/schema.test.js +130 -0
  23. package/dist/__tests__/schema.test.js.map +1 -0
  24. package/dist/__tests__/sql.test.d.ts +2 -0
  25. package/dist/__tests__/sql.test.d.ts.map +1 -0
  26. package/dist/__tests__/sql.test.js +35 -0
  27. package/dist/__tests__/sql.test.js.map +1 -0
  28. package/dist/__tests__/toolRegistry.test.d.ts +2 -0
  29. package/dist/__tests__/toolRegistry.test.d.ts.map +1 -0
  30. package/dist/__tests__/toolRegistry.test.js +47 -0
  31. package/dist/__tests__/toolRegistry.test.js.map +1 -0
  32. package/dist/__tests__/validation.test.d.ts +1 -1
  33. package/dist/__tests__/validation.test.js +110 -110
  34. package/dist/__tests__/validation.test.js.map +1 -1
  35. package/dist/__tests__/writeTools.test.d.ts +2 -0
  36. package/dist/__tests__/writeTools.test.d.ts.map +1 -0
  37. package/dist/__tests__/writeTools.test.js +115 -0
  38. package/dist/__tests__/writeTools.test.js.map +1 -0
  39. package/dist/config.d.ts +5 -0
  40. package/dist/config.d.ts.map +1 -0
  41. package/dist/config.js +34 -0
  42. package/dist/config.js.map +1 -0
  43. package/dist/db.d.ts +28 -24
  44. package/dist/db.d.ts.map +1 -1
  45. package/dist/db.js +144 -112
  46. package/dist/db.js.map +1 -1
  47. package/dist/index.d.ts +2 -2
  48. package/dist/index.js +70 -122
  49. package/dist/index.js.map +1 -1
  50. package/dist/promptRegistry.d.ts +16 -0
  51. package/dist/promptRegistry.d.ts.map +1 -0
  52. package/dist/promptRegistry.js +107 -0
  53. package/dist/promptRegistry.js.map +1 -0
  54. package/dist/resourceRegistry.d.ts +12 -0
  55. package/dist/resourceRegistry.d.ts.map +1 -0
  56. package/dist/resourceRegistry.js +172 -0
  57. package/dist/resourceRegistry.js.map +1 -0
  58. package/dist/schema.d.ts +41 -0
  59. package/dist/schema.d.ts.map +1 -0
  60. package/dist/schema.js +211 -0
  61. package/dist/schema.js.map +1 -0
  62. package/dist/sql.d.ts +7 -0
  63. package/dist/sql.d.ts.map +1 -0
  64. package/dist/sql.js +73 -0
  65. package/dist/sql.js.map +1 -0
  66. package/dist/toolRegistry.d.ts +16 -0
  67. package/dist/toolRegistry.d.ts.map +1 -0
  68. package/dist/toolRegistry.js +401 -0
  69. package/dist/toolRegistry.js.map +1 -0
  70. package/dist/tools/CreateIndexTool.d.ts +30 -23
  71. package/dist/tools/CreateIndexTool.d.ts.map +1 -1
  72. package/dist/tools/CreateIndexTool.js +47 -77
  73. package/dist/tools/CreateIndexTool.js.map +1 -1
  74. package/dist/tools/CreateTableTool.d.ts +18 -11
  75. package/dist/tools/CreateTableTool.d.ts.map +1 -1
  76. package/dist/tools/CreateTableTool.js +37 -61
  77. package/dist/tools/CreateTableTool.js.map +1 -1
  78. package/dist/tools/DeleteDataTool.d.ts +22 -0
  79. package/dist/tools/DeleteDataTool.d.ts.map +1 -0
  80. package/dist/tools/DeleteDataTool.js +35 -0
  81. package/dist/tools/DeleteDataTool.js.map +1 -0
  82. package/dist/tools/DescribeObjectTool.d.ts +21 -0
  83. package/dist/tools/DescribeObjectTool.d.ts.map +1 -0
  84. package/dist/tools/DescribeObjectTool.js +31 -0
  85. package/dist/tools/DescribeObjectTool.js.map +1 -0
  86. package/dist/tools/DescribeTableTool.d.ts +19 -20
  87. package/dist/tools/DescribeTableTool.d.ts.map +1 -1
  88. package/dist/tools/DescribeTableTool.js +23 -44
  89. package/dist/tools/DescribeTableTool.js.map +1 -1
  90. package/dist/tools/DropTableTool.d.ts +13 -11
  91. package/dist/tools/DropTableTool.d.ts.map +1 -1
  92. package/dist/tools/DropTableTool.js +30 -44
  93. package/dist/tools/DropTableTool.js.map +1 -1
  94. package/dist/tools/ExplainQueryTool.d.ts +32 -0
  95. package/dist/tools/ExplainQueryTool.d.ts.map +1 -0
  96. package/dist/tools/ExplainQueryTool.js +102 -0
  97. package/dist/tools/ExplainQueryTool.js.map +1 -0
  98. package/dist/tools/InsertDataTool.d.ts +20 -16
  99. package/dist/tools/InsertDataTool.d.ts.map +1 -1
  100. package/dist/tools/InsertDataTool.js +91 -108
  101. package/dist/tools/InsertDataTool.js.map +1 -1
  102. package/dist/tools/ListObjectsTool.d.ts +20 -0
  103. package/dist/tools/ListObjectsTool.d.ts.map +1 -0
  104. package/dist/tools/ListObjectsTool.js +26 -0
  105. package/dist/tools/ListObjectsTool.js.map +1 -0
  106. package/dist/tools/ListTableTool.d.ts +20 -16
  107. package/dist/tools/ListTableTool.d.ts.map +1 -1
  108. package/dist/tools/ListTableTool.js +32 -51
  109. package/dist/tools/ListTableTool.js.map +1 -1
  110. package/dist/tools/ReadDataTool.d.ts +35 -33
  111. package/dist/tools/ReadDataTool.d.ts.map +1 -1
  112. package/dist/tools/ReadDataTool.js +92 -105
  113. package/dist/tools/ReadDataTool.js.map +1 -1
  114. package/dist/tools/SearchDataTool.d.ts +27 -0
  115. package/dist/tools/SearchDataTool.d.ts.map +1 -0
  116. package/dist/tools/SearchDataTool.js +61 -0
  117. package/dist/tools/SearchDataTool.js.map +1 -0
  118. package/dist/tools/UpdateDataTool.d.ts +21 -16
  119. package/dist/tools/UpdateDataTool.d.ts.map +1 -1
  120. package/dist/tools/UpdateDataTool.js +45 -65
  121. package/dist/tools/UpdateDataTool.js.map +1 -1
  122. package/dist/validation.d.ts +13 -13
  123. package/dist/validation.js +133 -133
  124. package/dist/validation.js.map +1 -1
  125. package/dist/writeSafety.d.ts +21 -0
  126. package/dist/writeSafety.d.ts.map +1 -0
  127. package/dist/writeSafety.js +169 -0
  128. package/dist/writeSafety.js.map +1 -0
  129. package/package.json +5 -4
@@ -1,62 +1,38 @@
1
- import { getSqlRequest } from "../db.js";
2
- export class CreateTableTool {
3
- constructor() {
4
- this.name = "create_table";
5
- this.description = "Creates a new table in the MSSQL Database with the specified columns.";
6
- this.inputSchema = {
7
- type: "object",
8
- properties: {
9
- tableName: { type: "string", description: "Name of the table to create" },
10
- columns: {
11
- type: "array",
12
- description: "Array of column definitions (e.g., [{ name: 'id', type: 'INT PRIMARY KEY' }, ...])",
13
- items: {
14
- type: "object",
15
- properties: {
16
- name: { type: "string", description: "Column name" },
17
- type: {
18
- type: "string",
19
- description: "SQL type and constraints (e.g., 'INT PRIMARY KEY', 'NVARCHAR(255) NOT NULL')",
20
- },
21
- },
22
- required: ["name", "type"],
23
- },
24
- },
25
- databaseName: {
26
- type: "string",
27
- description: "Name of the database to use (optional). Omit to use the default configured database.",
28
- },
29
- },
30
- required: ["tableName", "columns"],
31
- };
32
- }
33
- async run(params) {
34
- try {
35
- const { tableName, columns, databaseName } = params;
36
- const { request, error } = await getSqlRequest(databaseName);
37
- if (error) {
38
- return { success: false, message: error };
39
- }
40
- if (!Array.isArray(columns) || columns.length === 0) {
41
- throw new Error("'columns' must be a non-empty array");
42
- }
43
- const columnDefs = columns
44
- .map((col) => `[${col.name}] ${col.type}`)
45
- .join(", ");
46
- const query = `CREATE TABLE [${tableName}] (${columnDefs})`;
47
- await request.query(query);
48
- return {
49
- success: true,
50
- message: `Table '${tableName}' created successfully.`,
51
- };
52
- }
53
- catch (error) {
54
- console.error("Error creating table:", error);
55
- return {
56
- success: false,
57
- message: `Failed to create table: ${error}`,
58
- };
59
- }
60
- }
61
- }
1
+ import { getSqlRequest } from "../db.js";
2
+ import { buildQualifiedName } from "../sql.js";
3
+ import { buildCreateColumnDefinition, } from "../writeSafety.js";
4
+ export class CreateTableTool {
5
+ constructor() {
6
+ this.name = "create_table";
7
+ this.description = "Creates a new table in the MSSQL Database with the specified columns.";
8
+ }
9
+ async run(params) {
10
+ try {
11
+ const { schemaName, tableName, columns, databaseName } = params;
12
+ const { request, error } = await getSqlRequest(databaseName);
13
+ if (error) {
14
+ return { success: false, message: error };
15
+ }
16
+ if (!Array.isArray(columns) || columns.length === 0) {
17
+ throw new Error("'columns' must be a non-empty array");
18
+ }
19
+ const columnDefs = columns
20
+ .map((col) => buildCreateColumnDefinition(col.name, col))
21
+ .join(", ");
22
+ const query = `CREATE TABLE ${buildQualifiedName(tableName, schemaName)} (${columnDefs})`;
23
+ await request.query(query);
24
+ return {
25
+ success: true,
26
+ message: `Table '${tableName}' created successfully.`,
27
+ };
28
+ }
29
+ catch (error) {
30
+ console.error("Error creating table:", error);
31
+ return {
32
+ success: false,
33
+ message: `Failed to create table: ${error}`,
34
+ };
35
+ }
36
+ }
37
+ }
62
38
  //# sourceMappingURL=CreateTableTool.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"CreateTableTool.js","sourceRoot":"","sources":["../../src/tools/CreateTableTool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,OAAO,eAAe;IAA5B;QAEE,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GACT,uEAAuE,CAAC;QAC1E,gBAAW,GAAG;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,6BAA6B,EAAE;gBACzE,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,WAAW,EACT,oFAAoF;oBACtF,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE;4BACpD,IAAI,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,WAAW,EACT,8EAA8E;6BACjF;yBACF;wBACD,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;qBAC3B;iBACF;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,sFAAsF;iBACzF;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;SAC5B,CAAC;IA+BX,CAAC;IA7BC,KAAK,CAAC,GAAG,CAAC,MAAW;QACnB,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YAEpD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE;gBACT,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;aAC3C;YAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aACxD;YACD,MAAM,UAAU,GAAG,OAAO;iBACvB,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;iBAC9C,IAAI,CAAC,IAAI,CAAC,CAAC;YACd,MAAM,KAAK,GAAG,iBAAiB,SAAS,MAAM,UAAU,GAAG,CAAC;YAC5D,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3B,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,UAAU,SAAS,yBAAyB;aACtD,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,2BAA2B,KAAK,EAAE;aAC5C,CAAC;SACH;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"CreateTableTool.js","sourceRoot":"","sources":["../../src/tools/CreateTableTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EACL,2BAA2B,GAE5B,MAAM,mBAAmB,CAAC;AAS3B,MAAM,OAAO,eAAe;IAA5B;QACE,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GACT,uEAAuE,CAAC;IA+B5E,CAAC;IA7BC,KAAK,CAAC,GAAG,CAAC,MAAyB;QACjC,IAAI,CAAC;YACH,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YAEhE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAC5C,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,UAAU,GAAG,OAAO;iBACvB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,2BAA2B,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;iBACxD,IAAI,CAAC,IAAI,CAAC,CAAC;YACd,MAAM,KAAK,GAAG,gBAAgB,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,UAAU,GAAG,CAAC;YAC1F,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3B,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,UAAU,SAAS,yBAAyB;aACtD,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,2BAA2B,KAAK,EAAE;aAC5C,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1,22 @@
1
+ import { type SqlFilter } from "../writeSafety.js";
2
+ interface DeleteDataParams {
3
+ tableName: string;
4
+ schemaName?: string;
5
+ filters: SqlFilter[];
6
+ databaseName?: string;
7
+ }
8
+ export declare class DeleteDataTool {
9
+ name: string;
10
+ description: string;
11
+ run(params: DeleteDataParams): Promise<{
12
+ success: boolean;
13
+ message: string;
14
+ rowsAffected?: undefined;
15
+ } | {
16
+ success: boolean;
17
+ message: string;
18
+ rowsAffected: number;
19
+ }>;
20
+ }
21
+ export {};
22
+ //# sourceMappingURL=DeleteDataTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DeleteDataTool.d.ts","sourceRoot":"","sources":["../../src/tools/DeleteDataTool.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiC,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAElF,UAAU,gBAAgB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,cAAc;IACzB,IAAI,SAAiB;IACrB,WAAW,SAC6D;IAElE,GAAG,CAAC,MAAM,EAAE,gBAAgB;;;;;;;;;CAiCnC"}
@@ -0,0 +1,35 @@
1
+ import { getSqlRequest } from "../db.js";
2
+ import { buildQualifiedName } from "../sql.js";
3
+ import { buildParameterizedWhereClause } from "../writeSafety.js";
4
+ export class DeleteDataTool {
5
+ constructor() {
6
+ this.name = "delete_data";
7
+ this.description = "Deletes rows from an MSSQL table using required structured filters.";
8
+ }
9
+ async run(params) {
10
+ let query;
11
+ try {
12
+ const { tableName, schemaName, filters, databaseName } = params;
13
+ const { request, error } = await getSqlRequest(databaseName);
14
+ if (error) {
15
+ return { success: false, message: error };
16
+ }
17
+ const whereClause = buildParameterizedWhereClause(filters, (name, value) => request.input(name, value), "delete_filter");
18
+ query = `DELETE FROM ${buildQualifiedName(tableName, schemaName)} WHERE ${whereClause}`;
19
+ const result = await request.query(query);
20
+ return {
21
+ success: true,
22
+ message: `Delete completed successfully. ${result.rowsAffected[0]} row(s) affected`,
23
+ rowsAffected: result.rowsAffected[0],
24
+ };
25
+ }
26
+ catch (error) {
27
+ console.error("Error deleting data:", error);
28
+ return {
29
+ success: false,
30
+ message: `Failed to delete data${query ? ` with '${query}'` : ""}: ${error}`,
31
+ };
32
+ }
33
+ }
34
+ }
35
+ //# sourceMappingURL=DeleteDataTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DeleteDataTool.js","sourceRoot":"","sources":["../../src/tools/DeleteDataTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,6BAA6B,EAAkB,MAAM,mBAAmB,CAAC;AASlF,MAAM,OAAO,cAAc;IAA3B;QACE,SAAI,GAAG,aAAa,CAAC;QACrB,gBAAW,GACT,qEAAqE,CAAC;IAmC1E,CAAC;IAjCC,KAAK,CAAC,GAAG,CAAC,MAAwB;QAChC,IAAI,KAAyB,CAAC;QAE9B,IAAI,CAAC;YACH,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YAEhE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAC5C,CAAC;YAED,MAAM,WAAW,GAAG,6BAA6B,CAC/C,OAAO,EACP,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,EAC3C,eAAe,CAChB,CAAC;YAEF,KAAK,GAAG,eAAe,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,UAAU,WAAW,EAAE,CAAC;YACxF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAE1C,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,kCAAkC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB;gBACnF,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;aACrC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;YAC7C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,wBAAwB,KAAK,CAAC,CAAC,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,EAAE;aAC7E,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1,21 @@
1
+ interface DescribeObjectParams {
2
+ objectName: string;
3
+ objectTypes?: string[];
4
+ schemaName?: string;
5
+ databaseName?: string;
6
+ }
7
+ export declare class DescribeObjectTool {
8
+ name: string;
9
+ description: string;
10
+ run(params: DescribeObjectParams): Promise<{
11
+ success: boolean;
12
+ message: string;
13
+ object?: undefined;
14
+ } | {
15
+ success: boolean;
16
+ object: import("../schema.js").DatabaseObjectDescription;
17
+ message?: undefined;
18
+ }>;
19
+ }
20
+ export {};
21
+ //# sourceMappingURL=DescribeObjectTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DescribeObjectTool.d.ts","sourceRoot":"","sources":["../../src/tools/DescribeObjectTool.ts"],"names":[],"mappings":"AAEA,UAAU,oBAAoB;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,kBAAkB;IAC7B,IAAI,SAAqB;IACzB,WAAW,SACoG;IAEzG,GAAG,CAAC,MAAM,EAAE,oBAAoB;;;;;;;;;CA6BvC"}
@@ -0,0 +1,31 @@
1
+ import { describeDatabaseObject } from "../schema.js";
2
+ export class DescribeObjectTool {
3
+ constructor() {
4
+ this.name = "describe_object";
5
+ this.description = "Describes a table, view, procedure, function, or trigger, including columns and definition when available.";
6
+ }
7
+ async run(params) {
8
+ try {
9
+ const { objectName, objectTypes, schemaName, databaseName } = params;
10
+ const object = await describeDatabaseObject(objectName, databaseName, schemaName, objectTypes);
11
+ if (!object) {
12
+ return {
13
+ success: false,
14
+ message: `No object named '${objectName}' was found.`,
15
+ };
16
+ }
17
+ return {
18
+ success: true,
19
+ object,
20
+ };
21
+ }
22
+ catch (error) {
23
+ console.error("Error describing object:", error);
24
+ return {
25
+ success: false,
26
+ message: `Failed to describe object: ${error}`,
27
+ };
28
+ }
29
+ }
30
+ }
31
+ //# sourceMappingURL=DescribeObjectTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DescribeObjectTool.js","sourceRoot":"","sources":["../../src/tools/DescribeObjectTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAStD,MAAM,OAAO,kBAAkB;IAA/B;QACE,SAAI,GAAG,iBAAiB,CAAC;QACzB,gBAAW,GACT,4GAA4G,CAAC;IA+BjH,CAAC;IA7BC,KAAK,CAAC,GAAG,CAAC,MAA4B;QACpC,IAAI,CAAC;YACH,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YACrE,MAAM,MAAM,GAAG,MAAM,sBAAsB,CACzC,UAAU,EACV,YAAY,EACZ,UAAU,EACV,WAAW,CACZ,CAAC;YAEF,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,oBAAoB,UAAU,cAAc;iBACtD,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,MAAM;aACP,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;YACjD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,8BAA8B,KAAK,EAAE;aAC/C,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
@@ -1,21 +1,20 @@
1
- import sql from "mssql";
2
- import { Tool } from "@modelcontextprotocol/sdk/types.js";
3
- export declare class DescribeTableTool implements Tool {
4
- [key: string]: any;
5
- name: string;
6
- description: string;
7
- inputSchema: any;
8
- run(params: {
9
- tableName: string;
10
- databaseName?: string;
11
- }): Promise<{
12
- success: boolean;
13
- message: string;
14
- columns?: undefined;
15
- } | {
16
- success: boolean;
17
- columns: sql.IRecordSet<any>;
18
- message?: undefined;
19
- }>;
20
- }
1
+ interface DescribeTableParams {
2
+ tableName: string;
3
+ schemaName?: string;
4
+ databaseName?: string;
5
+ }
6
+ export declare class DescribeTableTool {
7
+ name: string;
8
+ description: string;
9
+ run(params: DescribeTableParams): Promise<{
10
+ success: boolean;
11
+ columns: import("mssql").IRecordSet<any>;
12
+ message?: undefined;
13
+ } | {
14
+ success: boolean;
15
+ message: string;
16
+ columns?: undefined;
17
+ }>;
18
+ }
19
+ export {};
21
20
  //# sourceMappingURL=DescribeTableTool.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DescribeTableTool.d.ts","sourceRoot":"","sources":["../../src/tools/DescribeTableTool.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAG1D,qBAAa,iBAAkB,YAAW,IAAI;IAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,SAAoB;IACxB,WAAW,SACuE;IAClF,WAAW,MAcF;IAEH,GAAG,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;CAsB/D"}
1
+ {"version":3,"file":"DescribeTableTool.d.ts","sourceRoot":"","sources":["../../src/tools/DescribeTableTool.ts"],"names":[],"mappings":"AAEA,UAAU,mBAAmB;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,iBAAiB;IAC5B,IAAI,SAAoB;IACxB,WAAW,SACuE;IAE5E,GAAG,CAAC,MAAM,EAAE,mBAAmB;;;;;;;;;CAgBtC"}
@@ -1,45 +1,24 @@
1
- import sql from "mssql";
2
- import { getSqlRequest } from "../db.js";
3
- export class DescribeTableTool {
4
- constructor() {
5
- this.name = "describe_table";
6
- this.description = "Describes the schema (columns and types) of a specified MSSQL Database table.";
7
- this.inputSchema = {
8
- type: "object",
9
- properties: {
10
- tableName: {
11
- type: "string",
12
- description: "Name of the table to describe",
13
- },
14
- databaseName: {
15
- type: "string",
16
- description: "Name of the database to use (optional). Omit to use the default configured database.",
17
- },
18
- },
19
- required: ["tableName"],
20
- };
21
- }
22
- async run(params) {
23
- try {
24
- const { tableName, databaseName } = params;
25
- const { request, error } = await getSqlRequest(databaseName);
26
- if (error) {
27
- return { success: false, message: error };
28
- }
29
- const query = `SELECT COLUMN_NAME as name, DATA_TYPE as type FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = @tableName`;
30
- request.input("tableName", sql.NVarChar, tableName);
31
- const result = await request.query(query);
32
- return {
33
- success: true,
34
- columns: result.recordset,
35
- };
36
- }
37
- catch (error) {
38
- return {
39
- success: false,
40
- message: `Failed to describe table: ${error}`,
41
- };
42
- }
43
- }
44
- }
1
+ import { describeTableSchema } from "../schema.js";
2
+ export class DescribeTableTool {
3
+ constructor() {
4
+ this.name = "describe_table";
5
+ this.description = "Describes the schema (columns and types) of a specified MSSQL Database table.";
6
+ }
7
+ async run(params) {
8
+ try {
9
+ const { tableName, schemaName, databaseName } = params;
10
+ const columns = await describeTableSchema(tableName, databaseName, schemaName);
11
+ return {
12
+ success: true,
13
+ columns,
14
+ };
15
+ }
16
+ catch (error) {
17
+ return {
18
+ success: false,
19
+ message: `Failed to describe table: ${error}`,
20
+ };
21
+ }
22
+ }
23
+ }
45
24
  //# sourceMappingURL=DescribeTableTool.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"DescribeTableTool.js","sourceRoot":"","sources":["../../src/tools/DescribeTableTool.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AAExB,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,OAAO,iBAAiB;IAA9B;QAEE,SAAI,GAAG,gBAAgB,CAAC;QACxB,gBAAW,GACT,+EAA+E,CAAC;QAClF,gBAAW,GAAG;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,SAAS,EAAE;oBACT,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,+BAA+B;iBAC7C;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,sFAAsF;iBACzF;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,CAAC;SACjB,CAAC;IAwBX,CAAC;IAtBC,KAAK,CAAC,GAAG,CAAC,MAAoD;QAC5D,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YAE3C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE;gBACT,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;aAC3C;YACD,MAAM,KAAK,GAAG,6GAA6G,CAAC;YAC5H,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,MAAM,CAAC,SAAS;aAC1B,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6BAA6B,KAAK,EAAE;aAC9C,CAAC;SACH;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"DescribeTableTool.js","sourceRoot":"","sources":["../../src/tools/DescribeTableTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAQnD,MAAM,OAAO,iBAAiB;IAA9B;QACE,SAAI,GAAG,gBAAgB,CAAC;QACxB,gBAAW,GACT,+EAA+E,CAAC;IAkBpF,CAAC;IAhBC,KAAK,CAAC,GAAG,CAAC,MAA2B;QACnC,IAAI,CAAC;YACH,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YACvD,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;YAE/E,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO;aACR,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6BAA6B,KAAK,EAAE;aAC9C,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
@@ -1,12 +1,14 @@
1
- import { Tool } from "@modelcontextprotocol/sdk/types.js";
2
- export declare class DropTableTool implements Tool {
3
- [key: string]: any;
4
- name: string;
5
- description: string;
6
- inputSchema: any;
7
- run(params: any): Promise<{
8
- success: boolean;
9
- message: string;
10
- }>;
11
- }
1
+ interface DropTableParams {
2
+ tableName: string;
3
+ databaseName?: string;
4
+ }
5
+ export declare class DropTableTool {
6
+ name: string;
7
+ description: string;
8
+ run(params: DropTableParams): Promise<{
9
+ success: boolean;
10
+ message: string;
11
+ }>;
12
+ }
13
+ export {};
12
14
  //# sourceMappingURL=DropTableTool.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DropTableTool.d.ts","sourceRoot":"","sources":["../../src/tools/DropTableTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAG1D,qBAAa,aAAc,YAAW,IAAI;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,SAAgB;IACpB,WAAW,SAA4C;IACvD,WAAW,MAWF;IAEH,GAAG,CAAC,MAAM,EAAE,GAAG;;;;CA2BtB"}
1
+ {"version":3,"file":"DropTableTool.d.ts","sourceRoot":"","sources":["../../src/tools/DropTableTool.ts"],"names":[],"mappings":"AAGA,UAAU,eAAe;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,aAAa;IACxB,IAAI,SAAgB;IACpB,WAAW,SAA4C;IAEjD,GAAG,CAAC,MAAM,EAAE,eAAe;;;;CAuBlC"}
@@ -1,45 +1,31 @@
1
- import { getSqlRequest } from "../db.js";
2
- export class DropTableTool {
3
- constructor() {
4
- this.name = "drop_table";
5
- this.description = "Drops a table from the MSSQL Database.";
6
- this.inputSchema = {
7
- type: "object",
8
- properties: {
9
- tableName: { type: "string", description: "Name of the table to drop" },
10
- databaseName: {
11
- type: "string",
12
- description: "Name of the database to use (optional). Omit to use the default configured database.",
13
- },
14
- },
15
- required: ["tableName"],
16
- };
17
- }
18
- async run(params) {
19
- try {
20
- const { tableName, databaseName } = params;
21
- const { request, error } = await getSqlRequest(databaseName);
22
- if (error) {
23
- return { success: false, message: error };
24
- }
25
- // Basic validation to prevent SQL injection
26
- if (!/^[\w\d_]+$/.test(tableName)) {
27
- throw new Error("Invalid table name.");
28
- }
29
- const query = `DROP TABLE [${tableName}]`;
30
- await request.query(query);
31
- return {
32
- success: true,
33
- message: `Table '${tableName}' dropped successfully.`,
34
- };
35
- }
36
- catch (error) {
37
- console.error("Error dropping table:", error);
38
- return {
39
- success: false,
40
- message: `Failed to drop table: ${error}`,
41
- };
42
- }
43
- }
44
- }
1
+ import { getSqlRequest } from "../db.js";
2
+ import { buildQualifiedName } from "../sql.js";
3
+ export class DropTableTool {
4
+ constructor() {
5
+ this.name = "drop_table";
6
+ this.description = "Drops a table from the MSSQL Database.";
7
+ }
8
+ async run(params) {
9
+ try {
10
+ const { tableName, databaseName } = params;
11
+ const { request, error } = await getSqlRequest(databaseName);
12
+ if (error) {
13
+ return { success: false, message: error };
14
+ }
15
+ const query = `DROP TABLE ${buildQualifiedName(tableName)}`;
16
+ await request.query(query);
17
+ return {
18
+ success: true,
19
+ message: `Table '${tableName}' dropped successfully.`,
20
+ };
21
+ }
22
+ catch (error) {
23
+ console.error("Error dropping table:", error);
24
+ return {
25
+ success: false,
26
+ message: `Failed to drop table: ${error}`,
27
+ };
28
+ }
29
+ }
30
+ }
45
31
  //# sourceMappingURL=DropTableTool.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"DropTableTool.js","sourceRoot":"","sources":["../../src/tools/DropTableTool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,OAAO,aAAa;IAA1B;QAEE,SAAI,GAAG,YAAY,CAAC;QACpB,gBAAW,GAAG,wCAAwC,CAAC;QACvD,gBAAW,GAAG;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,2BAA2B,EAAE;gBACvE,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EACT,sFAAsF;iBACzF;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,CAAC;SACjB,CAAC;IA6BX,CAAC;IA3BC,KAAK,CAAC,GAAG,CAAC,MAAW;QACnB,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YAE3C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE;gBACT,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;aAC3C;YAED,4CAA4C;YAC5C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBACjC,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;aACxC;YACD,MAAM,KAAK,GAAG,eAAe,SAAS,GAAG,CAAC;YAC1C,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3B,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,UAAU,SAAS,yBAAyB;aACtD,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,yBAAyB,KAAK,EAAE;aAC1C,CAAC;SACH;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"DropTableTool.js","sourceRoot":"","sources":["../../src/tools/DropTableTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAO/C,MAAM,OAAO,aAAa;IAA1B;QACE,SAAI,GAAG,YAAY,CAAC;QACpB,gBAAW,GAAG,wCAAwC,CAAC;IAyBzD,CAAC;IAvBC,KAAK,CAAC,GAAG,CAAC,MAAuB;QAC/B,IAAI,CAAC;YACH,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YAE3C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAC5C,CAAC;YAED,MAAM,KAAK,GAAG,cAAc,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3B,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,UAAU,SAAS,yBAAyB;aACtD,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,yBAAyB,KAAK,EAAE;aAC1C,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1,32 @@
1
+ import sql from "mssql";
2
+ interface ExplainQueryParams {
3
+ query: string;
4
+ databaseName?: string;
5
+ }
6
+ export declare class ExplainQueryTool {
7
+ name: string;
8
+ description: string;
9
+ run(params: ExplainQueryParams): Promise<{
10
+ success: boolean;
11
+ message: string;
12
+ error: string;
13
+ planXml?: undefined;
14
+ recordsets?: undefined;
15
+ } | {
16
+ success: boolean;
17
+ message: string;
18
+ error?: undefined;
19
+ planXml?: undefined;
20
+ recordsets?: undefined;
21
+ } | {
22
+ success: boolean;
23
+ message: string;
24
+ planXml: string | null;
25
+ recordsets: {
26
+ [x: string]: sql.IRecordSet<any>;
27
+ } | sql.IRecordSet<any>[] | undefined;
28
+ error?: undefined;
29
+ }>;
30
+ }
31
+ export {};
32
+ //# sourceMappingURL=ExplainQueryTool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ExplainQueryTool.d.ts","sourceRoot":"","sources":["../../src/tools/ExplainQueryTool.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AAIxB,UAAU,kBAAkB;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAyCD,qBAAa,gBAAgB;IAC3B,IAAI,SAAmB;IACvB,WAAW,SAC6F;IAElG,GAAG,CAAC,MAAM,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;CA+DrC"}
@@ -0,0 +1,102 @@
1
+ import { getDedicatedSqlPool } from "../db.js";
2
+ import { validateReadQuery } from "../validation.js";
3
+ function cellLooksLikeShowPlanXml(value) {
4
+ if (typeof value === "string" && value.trimStart().startsWith("<")) {
5
+ return value;
6
+ }
7
+ if (Buffer.isBuffer(value)) {
8
+ const s = value.toString("utf16le").trimStart();
9
+ if (s.startsWith("<")) {
10
+ return s;
11
+ }
12
+ }
13
+ return null;
14
+ }
15
+ function extractPlanXml(recordsets) {
16
+ if (!Array.isArray(recordsets)) {
17
+ return null;
18
+ }
19
+ for (const recordset of recordsets) {
20
+ if (!Array.isArray(recordset)) {
21
+ continue;
22
+ }
23
+ const firstRow = recordset[0];
24
+ if (!firstRow || typeof firstRow !== "object") {
25
+ continue;
26
+ }
27
+ for (const value of Object.values(firstRow)) {
28
+ const xml = cellLooksLikeShowPlanXml(value);
29
+ if (xml) {
30
+ return xml;
31
+ }
32
+ }
33
+ }
34
+ return null;
35
+ }
36
+ export class ExplainQueryTool {
37
+ constructor() {
38
+ this.name = "explain_query";
39
+ this.description = "Returns an estimated SQL Server execution plan for a validated SELECT query without modifying data.";
40
+ }
41
+ async run(params) {
42
+ let pool;
43
+ let showplanEnabled = false;
44
+ try {
45
+ const { query, databaseName } = params;
46
+ const validation = validateReadQuery(query);
47
+ if (!validation.isValid) {
48
+ return {
49
+ success: false,
50
+ message: `Security validation failed: ${validation.error}`,
51
+ error: "SECURITY_VALIDATION_FAILED",
52
+ };
53
+ }
54
+ const { pool: dedicatedPool, error } = await getDedicatedSqlPool(databaseName);
55
+ if (error) {
56
+ return { success: false, message: error };
57
+ }
58
+ pool = dedicatedPool;
59
+ // Same pattern as SSMS: separate batches on one session, no explicit transaction.
60
+ // BEGIN TRANSACTION can prevent SHOWPLAN_XML from affecting the following SELECT.
61
+ // Use batch() so batches go through execSqlBatch (closer to SSMS client batch boundaries).
62
+ await pool.request().batch("SET SHOWPLAN_XML ON");
63
+ showplanEnabled = true;
64
+ const planResult = await pool.request().batch(query);
65
+ const planXml = extractPlanXml(planResult.recordsets);
66
+ return {
67
+ success: true,
68
+ message: planXml
69
+ ? "Estimated execution plan generated successfully."
70
+ : "Execution plan request completed, but no XML plan was returned.",
71
+ planXml,
72
+ recordsets: planXml ? undefined : planResult.recordsets,
73
+ };
74
+ }
75
+ catch (error) {
76
+ console.error("Error explaining query:", error);
77
+ return {
78
+ success: false,
79
+ message: `Failed to explain query: ${error}`,
80
+ };
81
+ }
82
+ finally {
83
+ if (pool && showplanEnabled) {
84
+ try {
85
+ await pool.request().batch("SET SHOWPLAN_XML OFF");
86
+ }
87
+ catch (cleanupError) {
88
+ console.error("Failed to disable SHOWPLAN_XML:", cleanupError);
89
+ }
90
+ }
91
+ if (pool) {
92
+ try {
93
+ await pool.close();
94
+ }
95
+ catch {
96
+ // Ignore pool close errors during cleanup.
97
+ }
98
+ }
99
+ }
100
+ }
101
+ }
102
+ //# sourceMappingURL=ExplainQueryTool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ExplainQueryTool.js","sourceRoot":"","sources":["../../src/tools/ExplainQueryTool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAOrD,SAAS,wBAAwB,CAAC,KAAc;IAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;QAChD,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,cAAc,CAAC,UAAmB;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC9C,SAAS;QACX,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,MAAM,GAAG,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;YAC5C,IAAI,GAAG,EAAE,CAAC;gBACR,OAAO,GAAG,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,OAAO,gBAAgB;IAA7B;QACE,SAAI,GAAG,eAAe,CAAC;QACvB,gBAAW,GACT,qGAAqG,CAAC;IAiE1G,CAAC;IA/DC,KAAK,CAAC,GAAG,CAAC,MAA0B;QAClC,IAAI,IAAoC,CAAC;QACzC,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;YACvC,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAC5C,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;gBACxB,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,+BAA+B,UAAU,CAAC,KAAK,EAAE;oBAC1D,KAAK,EAAE,4BAA4B;iBACpC,CAAC;YACJ,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,MAAM,mBAAmB,CAAC,YAAY,CAAC,CAAC;YAC/E,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAC5C,CAAC;YAED,IAAI,GAAG,aAAa,CAAC;YAErB,kFAAkF;YAClF,kFAAkF;YAClF,2FAA2F;YAC3F,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YAClD,eAAe,GAAG,IAAI,CAAC;YAEvB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrD,MAAM,OAAO,GAAG,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAEtD,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,OAAO;oBACd,CAAC,CAAC,kDAAkD;oBACpD,CAAC,CAAC,iEAAiE;gBACrE,OAAO;gBACP,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU;aACxD,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YAChD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,4BAA4B,KAAK,EAAE;aAC7C,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,IAAI,IAAI,IAAI,eAAe,EAAE,CAAC;gBAC5B,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;gBACrD,CAAC;gBAAC,OAAO,YAAY,EAAE,CAAC;oBACtB,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,YAAY,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC;YAED,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gBACrB,CAAC;gBAAC,MAAM,CAAC;oBACP,2CAA2C;gBAC7C,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF"}