snow-flow 10.0.1-dev.484 → 10.0.1-dev.486

package/package.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
-  "version": "10.0.1-dev.484",
+  "version": "10.0.1-dev.486",
   "name": "snow-flow",
   "description": "Snow-Flow - ServiceNow Multi-Agent Development Framework powered by AI",
   "license": "Elastic-2.0",

package/src/servicenow/servicenow-mcp-unified/tools/flow-designer/snow_manage_flow.ts

@@ -110,6 +110,21 @@ async function executeFlowPatchMutation(
   return resp.data?.data?.global?.snFlowDesigner?.flow || resp.data;
 }
 
+/**
+ * Release the Flow Designer editing lock on a flow.
+ * The UI calls safeEdit(delete: flowId) when closing the editor.
+ * Without this, the flow remains locked to the API user forever.
+ */
+async function releaseFlowEditingLock(client: any, flowId: string): Promise<boolean> {
+  try {
+    var mutation = 'mutation { global { snFlowDesigner { safeEdit(safeEditInput: {delete: "' + flowId + '"}) { deleteResult { deleteSuccess id __typename } __typename } __typename } __typename } }';
+    var resp = await client.post('/api/now/graphql', { variables: {}, query: mutation });
+    return resp.data?.data?.global?.snFlowDesigner?.safeEdit?.deleteResult?.deleteSuccess === true;
+  } catch (_) {
+    return false;
+  }
+}
+
 /** Safely extract a string from a ServiceNow Table API value (handles reference objects like {value, link}). */
 const str = (val: any): string =>
   typeof val === 'object' && val !== null ? (val.display_value || val.value || '') : (val || '');
@@ -1662,7 +1677,7 @@ async function transformActionInputsForRecordAction(
   resolvedInputs: Record<string, string>,
   actionParams: any[],
   uuid: string
-): Promise<{ inputs: any[]; labelCacheEntries: any[]; steps: any }> {
+): Promise<{ inputs: any[]; labelCacheUpdates: any[]; labelCacheInserts: any[]; steps: any }> {
   var steps: any = {};
 
   // Detect if this is a record action: must have both `record` and `table_name` parameters
@@ -1673,7 +1688,7 @@ async function transformActionInputsForRecordAction(
 
   if (!hasRecord || !hasTableName) {
     steps.record_action = false;
-    return { inputs: actionInputs, labelCacheEntries: [], steps };
+    return { inputs: actionInputs, labelCacheUpdates: [], labelCacheInserts: [], steps };
   }
   steps.record_action = true;
 
@@ -2490,9 +2505,10 @@ export const toolDefinition: MCPToolDefinition = {
           'add_trigger', 'update_trigger', 'delete_trigger',
           'add_action', 'update_action', 'delete_action',
           'add_flow_logic', 'update_flow_logic', 'delete_flow_logic',
-          'add_subflow', 'update_subflow', 'delete_subflow'
+          'add_subflow', 'update_subflow', 'delete_subflow',
+          'close_flow'
         ],
-        description: 'Action to perform. add_*/update_*/delete_* for triggers, actions, flow_logic, subflows. update_trigger replaces the trigger type. update_action/update_flow_logic/update_subflow change input values. delete_* removes elements by element_id.'
+        description: 'Action to perform. add_*/update_*/delete_* for triggers, actions, flow_logic, subflows. update_trigger replaces the trigger type. update_action/update_flow_logic/update_subflow change input values. delete_* removes elements by element_id. IMPORTANT: When making multiple edits to a flow (add_action, add_flow_logic, etc.), call close_flow as the LAST step to release the editing lock. Without close_flow, the flow stays locked and cannot be edited in the UI. create_flow auto-releases the lock.'
       },
 
       flow_id: {
@@ -2580,7 +2596,18 @@ export const toolDefinition: MCPToolDefinition = {
       },
       logic_type: {
         type: 'string',
-        description: 'Flow logic type for add_flow_logic. Looked up dynamically in sys_hub_flow_logic_definition. Common values: IF, ELSE, FOR_EACH, DO_UNTIL, SWITCH. IMPORTANT: ELSE blocks require connected_to set to the If block\'s uiUniqueIdentifier. IF does NOT require an Else block — only add Else if explicitly requested.'
+        description: 'Flow logic type for add_flow_logic. Looked up dynamically in sys_hub_flow_logic_definition. Available types: ' +
+          'IF, ELSEIF, ELSE — conditional branching. Use ELSEIF (not nested ELSE+IF) for else-if branches. ELSE and ELSEIF require connected_to set to the If block\'s uiUniqueIdentifier. ' +
+          'FOR_EACH, DO_UNTIL — loops. SKIP_ITERATION and EXIT_LOOP can be used inside loops. ' +
+          'PARALLEL — execute branches in parallel. ' +
+          'DECISION — switch/decision table. ' +
+          'TRY — error handling (try/catch). ' +
+          'END — End Flow (stops execution). Always add END as the last element when the flow should terminate cleanly. ' +
+          'TIMER — Wait for a duration of time. ' +
+          'GO_BACK_TO — jump back to a previous step. ' +
+          'SET_FLOW_VARIABLES, APPEND_FLOW_VARIABLES, GET_FLOW_OUTPUT — flow variable management. ' +
+          'WORKFLOW — call a legacy workflow. DYNAMIC_FLOW — dynamically invoke a flow. ' +
+          'Best practice: add an END element at the end of your flow for clean termination.'
       },
       logic_inputs: {
         type: 'object',
@@ -3067,6 +3094,12 @@ export async function execute(args: any, context: ServiceNowContext): Promise<To
           }
         }
 
+        // Release Flow Designer editing lock (safeEdit delete) so users can edit the flow in the UI
+        if (flowSysId) {
+          var lockReleased = await releaseFlowEditingLock(client, flowSysId);
+          diagnostics.editing_lock_released = lockReleased;
+        }
+
         return createSuccessResult({
           created: true,
           method: usedMethod,
@@ -3555,7 +3588,7 @@ export async function execute(args: any, context: ServiceNowContext): Promise<To
           throw new SnowFlowError(ErrorType.VALIDATION_ERROR, 'flow_id is required for add_flow_logic');
         }
         if (!args.logic_type) {
-          throw new SnowFlowError(ErrorType.VALIDATION_ERROR, 'logic_type is required for add_flow_logic (e.g. IF, FOR_EACH, DO_UNTIL, SWITCH)');
+          throw new SnowFlowError(ErrorType.VALIDATION_ERROR, 'logic_type is required for add_flow_logic (e.g. IF, ELSEIF, ELSE, FOR_EACH, DO_UNTIL, PARALLEL, DECISION, TRY, END, TIMER, SET_FLOW_VARIABLES)');
         }
         var addLogicFlowId = await resolveFlowId(client, args.flow_id);
         var addLogicType = args.logic_type;
@@ -3673,6 +3706,22 @@ export async function execute(args: any, context: ServiceNowContext): Promise<To
           : createErrorResult(delResult.error || 'Failed to delete element');
       }
 
+      // ────────────────────────────────────────────────────────────────
+      // CLOSE_FLOW — release Flow Designer editing lock (safeEdit)
+      // ────────────────────────────────────────────────────────────────
+      case 'close_flow': {
+        if (!args.flow_id) throw new SnowFlowError(ErrorType.VALIDATION_ERROR, 'flow_id is required for close_flow');
+        var closeFlowId = await resolveFlowId(client, args.flow_id);
+        var closed = await releaseFlowEditingLock(client, closeFlowId);
+        var closeSummary = summary();
+        if (closed) {
+          closeSummary.success('Flow editing lock released').field('Flow', closeFlowId);
+        } else {
+          closeSummary.warning('Lock release returned false (flow may not have been locked)').field('Flow', closeFlowId);
+        }
+        return createSuccessResult({ action: 'close_flow', flow_id: closeFlowId, lock_released: closed }, {}, closeSummary.build());
+      }
+
       default:
         throw new SnowFlowError(ErrorType.VALIDATION_ERROR, 'Unknown action: ' + action);
     }