activate_workflow
Initiate and activate workflows in ServiceNow by specifying the workflow ID or sys_id, enabling task automation and process management.
Instructions
Activate a workflow in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_id | Yes | Workflow ID or sys_id |
Implementation Reference
- The core handler function for the activate_workflow tool. It unwraps input parameters using the schema, handles authentication/config, and performs a PATCH request to the ServiceNow wf_workflow table to set active=true.def activate_workflow( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Activate a workflow in ServiceNow. Args: auth_manager: Authentication manager server_config: Server configuration params: Parameters for activating a workflow Returns: Dict[str, Any]: Activated workflow details """ # Unwrap parameters if needed params = _unwrap_params(params, ActivateWorkflowParams) # 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"} # Prepare data for the API request data = { "active": "true", } # Make the API request try: headers = auth_manager.get_headers() url = f"{server_config.instance_url}/api/now/table/wf_workflow/{workflow_id}" response = requests.patch(url, headers=headers, json=data) response.raise_for_status() result = response.json() return { "workflow": result.get("result", {}), "message": "Workflow activated successfully", } except requests.RequestException as e: logger.error(f"Error activating workflow: {e}") return {"error": str(e)} except Exception as e: logger.error(f"Unexpected error activating workflow: {e}") return {"error": str(e)}
- Pydantic BaseModel defining the input schema for activate_workflow: requires 'workflow_id' (str). Used for validation and JSON schema generation in MCP tool description.class ActivateWorkflowParams(BaseModel): """Parameters for activating a workflow.""" workflow_id: str = Field(..., description="Workflow ID or sys_id")
- src/servicenow_mcp/utils/tool_utils.py:532-538 (registration)Tool registration entry in get_tool_definitions() dict. Associates the aliased handler function, input schema model, return type hint, description, and output serialization method ('str') for use by the MCP server."activate_workflow": ( activate_workflow_tool, ActivateWorkflowParams, str, "Activate a workflow in ServiceNow", "str", # Tool returns simple message ),
- src/servicenow_mcp/tools/__init__.py:78-79 (registration)Imports the activate_workflow handler from workflow_tools.py, making it available for aliasing and use in tool_utils.py and the overall tools namespace.from servicenow_mcp.tools.workflow_tools import ( activate_workflow,
- Helper function used by activate_workflow (and other tools) to normalize input params to dict, handling both dict and Pydantic model inputs.def _unwrap_params(params: Any, param_class: Type[T]) -> Dict[str, Any]: """ Unwrap parameters if they're wrapped in a Pydantic model. This helps handle cases where the parameters are passed as a model instead of a dict. """ if isinstance(params, dict): return params if isinstance(params, param_class): return params.dict(exclude_none=True) return params