reorder_workflow_activities
Change the sequence of activities in a ServiceNow workflow by specifying the new order of activity IDs for a given workflow ID.
Instructions
Reorder activities in a workflow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_id | Yes | Workflow ID or sys_id | |
| activity_ids | Yes | List of activity IDs in the desired order |
Implementation Reference
- The core handler function that executes the tool logic. It unwraps parameters using ReorderWorkflowActivitiesParams, authenticates, and iteratively PATCHes the 'order' field on each wf_activity record via the ServiceNow REST API to achieve reordering.def reorder_workflow_activities( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Reorder activities in a workflow. Args: auth_manager: Authentication manager server_config: Server configuration params: Parameters for reordering workflow activities Returns: Dict[str, Any]: Result of the reordering operation """ # Unwrap parameters if needed params = _unwrap_params(params, ReorderWorkflowActivitiesParams) # Get the correct auth_manager and server_config try: auth_manager, server_config = _get_auth_and_config(auth_manager, server_config) except ValueError as e: logger.error(f"Error getting auth and config: {e}") return {"error": str(e)} workflow_id = params.get("workflow_id") if not workflow_id: return {"error": "Workflow ID is required"} activity_ids = params.get("activity_ids") if not activity_ids: return {"error": "Activity IDs are required"} # Make the API requests to update the order of each activity try: headers = auth_manager.get_headers() results = [] for i, activity_id in enumerate(activity_ids): # Calculate the new order value (100, 200, 300, etc.) new_order = (i + 1) * 100 url = f"{server_config.instance_url}/api/now/table/wf_activity/{activity_id}" data = {"order": new_order} try: response = requests.patch(url, headers=headers, json=data) response.raise_for_status() results.append({ "activity_id": activity_id, "new_order": new_order, "success": True, }) except requests.RequestException as e: logger.error(f"Error updating activity order: {e}") results.append({ "activity_id": activity_id, "error": str(e), "success": False, }) return { "message": "Activities reordered", "workflow_id": workflow_id, "results": results, } except Exception as e: logger.error(f"Unexpected error reordering workflow activities: {e}") return {"error": str(e)}
- Pydantic BaseModel defining the input schema for the tool, validating workflow_id (str) and activity_ids (list of str). Used for parameter unwrapping and validation.class ReorderWorkflowActivitiesParams(BaseModel): """Parameters for reordering workflow activities.""" workflow_id: str = Field(..., description="Workflow ID or sys_id") activity_ids: List[str] = Field(..., description="List of activity IDs in the desired order")
- src/servicenow_mcp/utils/tool_utils.py:567-573 (registration)MCP tool registration in the central tool_definitions dictionary. Maps tool name to (handler function alias, params schema, return type, description, serialization method). This is used by the MCP server to expose the tool."reorder_workflow_activities": ( reorder_workflow_activities_tool, ReorderWorkflowActivitiesParams, str, "Reorder activities in a workflow", "str", # Tool returns simple message ),
- src/servicenow_mcp/utils/tool_utils.py:281-282 (registration)Import of the handler function aliased as reorder_workflow_activities_tool for use in tool registration.from servicenow_mcp.tools.workflow_tools import ( reorder_workflow_activities as reorder_workflow_activities_tool,
- src/servicenow_mcp/tools/__init__.py:88-88 (registration)Re-export of the handler from workflow_tools.py in the tools package __init__, making it available for imports in tool_utils.py.reorder_workflow_activities,