activate_workflow
Initiate and execute workflows in ServiceNow by specifying the workflow ID, enabling automation of processes and task management through the MCP server integration.
Instructions
Activate a workflow in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Implementation Reference
- The handler function that executes the tool: validates params, makes PATCH request to /api/now/table/wf_workflow/{id} to set active=true, returns workflow details or error.
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 input schema defining the required 'workflow_id' parameter.
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:589-595 (registration)Registration of the tool in the central tool_definitions dictionary used by the MCP server: maps name to (handler, schema, return_type, description, serialization).
"activate_workflow": ( activate_workflow_tool, ActivateWorkflowParams, str, "Activate a workflow in ServiceNow", "str", # Tool returns simple message ),