@sonisoft/now-sdk-ext-mcp 1.0.0 → 2.2.0

package/dist/tools/xml-record.js

@@ -0,0 +1,145 @@
+import { z } from "zod";
+import { XMLRecordManager } from "@sonisoft/now-sdk-ext-core";
+import { withConnectionRetry } from "../common/connection.js";
+/**
+ * Instance parameter description shared across XML record tools.
+ */
+const INSTANCE_DESC = "The ServiceNow instance auth alias to use. " +
+    'This is the alias configured via `now-sdk auth --add` (e.g., "dev224436", "prod", "test"). ' +
+    'The user will typically refer to this by name when saying things like "on my dev224436 instance". ' +
+    "If not provided, falls back to the SN_AUTH_ALIAS environment variable.";
+// ============================================================
+// 1. export_record_xml
+// ============================================================
+/**
+ * Registers the export_record_xml tool on the MCP server.
+ *
+ * Exports a single record as ServiceNow unload XML format via the
+ * /<table>.do?UNL endpoint.
+ */
+export function registerExportRecordXmlTool(server) {
+    server.registerTool("export_record_xml", {
+        title: "Export Record as XML",
+        description: "Export a single record from a ServiceNow instance in unload XML format. " +
+            "Uses the /<table>.do?UNL endpoint to generate ServiceNow-native XML that " +
+            "can be imported into another instance or used as a configuration backup.\n\n" +
+            "Common use cases:\n" +
+            "- Backing up a Script Include, Business Rule, or other configuration record\n" +
+            "- Exporting a record to transfer it to another instance\n" +
+            "- Comparing record definitions across instances\n" +
+            "- Generating XML for inclusion in an update set",
+        inputSchema: {
+            instance: z.string().optional().describe(INSTANCE_DESC),
+            table: z
+                .string()
+                .describe("The table name of the record to export (e.g., 'sys_script_include', " +
+                "'sys_script', 'incident', 'sys_ui_page', 'kb_knowledge')."),
+            sys_id: z
+                .string()
+                .describe("The sys_id of the record to export."),
+        },
+    }, async ({ instance, table, sys_id }) => {
+        try {
+            const result = await withConnectionRetry(instance, async (snInstance) => {
+                const mgr = new XMLRecordManager(snInstance);
+                return await mgr.exportRecord({ table, sysId: sys_id });
+            });
+            const summary = `Exported record from ${result.table}/${result.sysId}` +
+                (result.unloadDate ? ` (unload date: ${result.unloadDate})` : "") +
+                ` — ${Buffer.byteLength(result.xml, "utf8")} bytes of XML`;
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: summary + "\n\n" + result.xml,
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Error exporting record: ${message}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    });
+}
+// ============================================================
+// 2. import_records_xml
+// ============================================================
+/**
+ * Registers the import_records_xml tool on the MCP server.
+ *
+ * Imports XML records into ServiceNow via the sys_upload.do processor.
+ */
+export function registerImportRecordsXmlTool(server) {
+    server.registerTool("import_records_xml", {
+        title: "Import Records from XML",
+        description: "Import XML records into a ServiceNow instance via the sys_upload.do processor. " +
+            "Accepts ServiceNow unload XML format (the output of export_record_xml or " +
+            "update set XML exports).\n\n" +
+            "IMPORTANT: This is a mutative operation that creates or updates records on the " +
+            "instance. Always verify the XML content and target table before importing. " +
+            "Use this for restoring configurations, migrating records between instances, " +
+            "or applying exported record definitions.",
+        inputSchema: {
+            instance: z.string().optional().describe(INSTANCE_DESC),
+            xml_content: z
+                .string()
+                .describe("The XML content to import in ServiceNow unload format. This is typically " +
+                "the output from export_record_xml or an XML update set export."),
+            target_table: z
+                .string()
+                .describe("The target table to import the records into (e.g., 'sys_script_include', " +
+                "'sys_script', 'incident'). Must match the table in the XML content."),
+        },
+    }, async ({ instance, xml_content, target_table }) => {
+        try {
+            const result = await withConnectionRetry(instance, async (snInstance) => {
+                const mgr = new XMLRecordManager(snInstance);
+                return await mgr.importRecords({
+                    xmlContent: xml_content,
+                    targetTable: target_table,
+                });
+            });
+            if (!result.success) {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: `Import failed for records into table '${result.targetTable}'.`,
+                        },
+                    ],
+                    isError: true,
+                };
+            }
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Successfully imported records into table '${result.targetTable}'.`,
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `Error importing records: ${message}`,
+                    },
+                ],
+                isError: true,
+            };
+        }
+    });
+}
+//# sourceMappingURL=xml-record.js.map

package/dist/tools/xml-record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xml-record.js","sourceRoot":"","sources":["../../src/tools/xml-record.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;GAEG;AACH,MAAM,aAAa,GACjB,6CAA6C;IAC7C,6FAA6F;IAC7F,oGAAoG;IACpG,wEAAwE,CAAC;AAE3E,+DAA+D;AAC/D,uBAAuB;AACvB,+DAA+D;AAE/D;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CAAC,MAAiB;IAC3D,MAAM,CAAC,YAAY,CACjB,mBAAmB,EACnB;QACE,KAAK,EAAE,sBAAsB;QAC7B,WAAW,EACT,0EAA0E;YAC1E,2EAA2E;YAC3E,8EAA8E;YAC9E,qBAAqB;YACrB,+EAA+E;YAC/E,2DAA2D;YAC3D,mDAAmD;YACnD,iDAAiD;QACnD,WAAW,EAAE;YACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;YACvD,KAAK,EAAE,CAAC;iBACL,MAAM,EAAE;iBACR,QAAQ,CACP,sEAAsE;gBACtE,2DAA2D,CAC5D;YACH,MAAM,EAAE,CAAC;iBACN,MAAM,EAAE;iBACR,QAAQ,CAAC,qCAAqC,CAAC;SACnD;KACF,EACD,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;QACpC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBACtE,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAC7C,OAAO,MAAM,GAAG,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,GACX,wBAAwB,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE;gBACtD,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAkB,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjE,MAAM,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC;YAE7D,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG;qBACpC;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,2BAA2B,OAAO,EAAE;qBAC3C;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC;AAED,+DAA+D;AAC/D,wBAAwB;AACxB,+DAA+D;AAE/D;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAAiB;IAC5D,MAAM,CAAC,YAAY,CACjB,oBAAoB,EACpB;QACE,KAAK,EAAE,yBAAyB;QAChC,WAAW,EACT,iFAAiF;YACjF,2EAA2E;YAC3E,8BAA8B;YAC9B,iFAAiF;YACjF,6EAA6E;YAC7E,8EAA8E;YAC9E,0CAA0C;QAC5C,WAAW,EAAE;YACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;YACvD,WAAW,EAAE,CAAC;iBACX,MAAM,EAAE;iBACR,QAAQ,CACP,2EAA2E;gBAC3E,gEAAgE,CACjE;YACH,YAAY,EAAE,CAAC;iBACZ,MAAM,EAAE;iBACR,QAAQ,CACP,2EAA2E;gBAC3E,qEAAqE,CACtE;SACJ;KACF,EACD,KAAK,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,EAAE,EAAE;QAChD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBACtE,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAC7C,OAAO,MAAM,GAAG,CAAC,aAAa,CAAC;oBAC7B,UAAU,EAAE,WAAW;oBACvB,WAAW,EAAE,YAAY;iBAC1B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAe;4BACrB,IAAI,EAAE,yCAAyC,MAAM,CAAC,WAAW,IAAI;yBACtE;qBACF;oBACD,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,6CAA6C,MAAM,CAAC,WAAW,IAAI;qBAC1E;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,4BAA4B,OAAO,EAAE;qBAC5C;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonisoft/now-sdk-ext-mcp",
-  "version": "1.0.0",
+  "version": "2.2.0",
   "description": "MCP server for interacting with ServiceNow instances via @sonisoft/now-sdk-ext-core",
   "keywords": [
     "servicenow",
@@ -42,19 +42,25 @@
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.26.0",
-    "@servicenow/sdk": "4.0.2",
-    "@servicenow/sdk-cli": "4.0.2",
+    "@servicenow/sdk": "4.3.0",
+    "@servicenow/sdk-cli": "4.3.0",
     "@servicenow/sdk-cli-core": "3.0.2",
-    "@servicenow/sdk-core": "4.0.2",
-    "@sonisoft/now-sdk-ext-core": "^2.5.2",
+    "@servicenow/sdk-core": "4.3.0",
+    "@sonisoft/now-sdk-ext-core": "^3.4.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/npm": "^13.1.4",
+    "@semantic-release/release-notes-generator": "^14.1.0",
     "@types/jest": "^30.0.0",
     "@types/node": "^22.3.0",
     "jest": "^30.2.0",
     "jest-junit": "^16.0.0",
     "rimraf": "^6.0.0",
+    "semantic-release": "^25.0.3",
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4"
@@ -63,6 +69,6 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=22.0.0"
   }
 }