delete_workflow_activity
Remove an activity from a ServiceNow workflow by specifying its ID to maintain process efficiency and organization.
Instructions
Delete an activity from a workflow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| activity_id | Yes | Activity ID or sys_id |
Implementation Reference
- The handler function that executes the tool logic: unwraps parameters using the schema, authenticates, and sends a DELETE request to the ServiceNow API to delete the specified workflow activity.def delete_workflow_activity( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Delete an activity from a workflow. Args: auth_manager: Authentication manager server_config: Server configuration params: Parameters for deleting a workflow activity Returns: Dict[str, Any]: Result of the deletion operation """ # Unwrap parameters if needed params = _unwrap_params(params, DeleteWorkflowActivityParams) # 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)} activity_id = params.get("activity_id") if not activity_id: return {"error": "Activity ID is required"} # Make the API request try: headers = auth_manager.get_headers() url = f"{server_config.instance_url}/api/now/table/wf_activity/{activity_id}" response = requests.delete(url, headers=headers) response.raise_for_status() return { "message": "Activity deleted successfully", "activity_id": activity_id, } except requests.RequestException as e: logger.error(f"Error deleting workflow activity: {e}") return {"error": str(e)} except Exception as e: logger.error(f"Unexpected error deleting workflow activity: {e}") return {"error": str(e)}
- Pydantic model defining the input parameters for the tool, requiring an activity_id.class DeleteWorkflowActivityParams(BaseModel): """Parameters for deleting a workflow activity.""" activity_id: str = Field(..., description="Activity ID or sys_id")
- src/servicenow_mcp/utils/tool_utils.py:606-612 (registration)Registers the tool in the MCP server's tool definitions dictionary, associating the name with the handler, schema, return type hint, description, and serialization method."delete_workflow_activity": ( delete_workflow_activity_tool, DeleteWorkflowActivityParams, str, "Delete an activity from a workflow", "str", # Tool returns simple message ),
- src/servicenow_mcp/tools/__init__.py:78-91 (registration)Imports the delete_workflow_activity handler from workflow_tools.py into the tools package namespace.from servicenow_mcp.tools.workflow_tools import ( activate_workflow, add_workflow_activity, create_workflow, deactivate_workflow, delete_workflow_activity, get_workflow_activities, get_workflow_details, list_workflow_versions, list_workflows, reorder_workflow_activities, update_workflow, update_workflow_activity, )
- src/servicenow_mcp/utils/tool_utils.py:266-268 (registration)Imports and aliases the handler function for use in tool registration.from servicenow_mcp.tools.workflow_tools import ( delete_workflow_activity as delete_workflow_activity_tool, )