deactivate_workflow

Disable a specific workflow in ServiceNow by providing its ID, ensuring it no longer executes automated processes within the platform.

Instructions

Deactivate a workflow in ServiceNow

Input Schema

TableJSON Schema

Name	Required	Description	Default
`params`	Yes

Implementation Reference

src/servicenow_mcp/tools/workflow_tools.py:648-701 (handler)

The core handler function that performs the deactivation by sending a PATCH request to the ServiceNow wf_workflow table API endpoint to set active=false.

def deactivate_workflow(
    auth_manager: AuthManager,
    server_config: ServerConfig,
    params: Dict[str, Any],
) -> Dict[str, Any]:
    """
    Deactivate a workflow in ServiceNow.
    
    Args:
        auth_manager: Authentication manager
        server_config: Server configuration
        params: Parameters for deactivating a workflow
        
    Returns:
        Dict[str, Any]: Deactivated workflow details
    """
    # Unwrap parameters if needed
    params = _unwrap_params(params, DeactivateWorkflowParams)
    
    # 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": "false",
    }
    
    # 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 deactivated successfully",
        }
    except requests.RequestException as e:
        logger.error(f"Error deactivating workflow: {e}")
        return {"error": str(e)}
    except Exception as e:
        logger.error(f"Unexpected error deactivating workflow: {e}")
        return {"error": str(e)}

src/servicenow_mcp/tools/workflow_tools.py:82-86 (schema)

Pydantic BaseModel defining the input schema for the tool, requiring a workflow_id.

class DeactivateWorkflowParams(BaseModel):
    """Parameters for deactivating a workflow."""
    
    workflow_id: str = Field(..., description="Workflow ID or sys_id")

src/servicenow_mcp/utils/tool_utils.py:596-602 (registration)
Registration of the tool in the central get_tool_definitions() dictionary, associating the name with the imported handler function, schema, return type, description, and serialization method.
```
"deactivate_workflow": (
    deactivate_workflow_tool,
    DeactivateWorkflowParams,
    str,
    "Deactivate a workflow in ServiceNow",
    "str",  # Tool returns simple message
),
```
src/servicenow_mcp/tools/__init__.py:83-83 (registration)
Import of the deactivate_workflow handler into the tools package namespace for exposure.
```
deactivate_workflow,
```

src/servicenow_mcp/tools/workflow_tools.py:138-181 (helper)

Helper function used by the handler to normalize auth_manager and server_config arguments, handling potential order swaps.

def _get_auth_and_config(
    auth_manager_or_config: Union[AuthManager, ServerConfig],
    server_config_or_auth: Union[ServerConfig, AuthManager],
) -> tuple[AuthManager, ServerConfig]:
    """
    Get the correct auth_manager and server_config objects.
    
    This function handles the case where the parameters might be swapped.
    
    Args:
        auth_manager_or_config: Either an AuthManager or a ServerConfig.
        server_config_or_auth: Either a ServerConfig or an AuthManager.
        
    Returns:
        tuple[AuthManager, ServerConfig]: The correct auth_manager and server_config.
        
    Raises:
        ValueError: If the parameters are not of the expected types.
    """
    # Check if the parameters are in the correct order
    if isinstance(auth_manager_or_config, AuthManager) and isinstance(server_config_or_auth, ServerConfig):
        return auth_manager_or_config, server_config_or_auth
    
    # Check if the parameters are swapped
    if isinstance(auth_manager_or_config, ServerConfig) and isinstance(server_config_or_auth, AuthManager):
        return server_config_or_auth, auth_manager_or_config
    
    # If we get here, at least one of the parameters is not of the expected type
    if hasattr(auth_manager_or_config, "get_headers"):
        auth_manager = auth_manager_or_config
    elif hasattr(server_config_or_auth, "get_headers"):
        auth_manager = server_config_or_auth
    else:
        raise ValueError("Cannot find get_headers method in either auth_manager or server_config")
    
    if hasattr(auth_manager_or_config, "instance_url"):
        server_config = auth_manager_or_config
    elif hasattr(server_config_or_auth, "instance_url"):
        server_config = server_config_or_auth
    else:
        raise ValueError("Cannot find instance_url attribute in either auth_manager or server_config")
    
    return auth_manager, server_config

ServiceNow MCP Server