update_workflow_activity
Modify an existing workflow activity in ServiceNow by updating its name, description, or attributes to adapt business processes.
Instructions
Update an existing activity in a workflow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| activity_id | Yes | Activity ID or sys_id | |
| attributes | No | Additional attributes for the activity | |
| description | No | Description of the activity | |
| name | No | Name of the activity |
Implementation Reference
- Main handler function for the update_workflow_activity tool. Handles input parameters, makes a PATCH request to ServiceNow's wf_activity table to update the activity.def update_workflow_activity( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Update an existing activity in a workflow. Args: auth_manager: Authentication manager server_config: Server configuration params: Parameters for updating a workflow activity Returns: Dict[str, Any]: Updated workflow activity details """ # Unwrap parameters if needed params = _unwrap_params(params, UpdateWorkflowActivityParams) # 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"} # Prepare data for the API request data = {} if params.get("name"): data["name"] = params["name"] if params.get("description") is not None: data["description"] = params["description"] if params.get("attributes"): # Add any additional attributes data.update(params["attributes"]) if not data: return {"error": "No update parameters provided"} # 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.patch(url, headers=headers, json=data) response.raise_for_status() result = response.json() return { "activity": result.get("result", {}), "message": "Activity updated successfully", } except requests.RequestException as e: logger.error(f"Error updating workflow activity: {e}") return {"error": str(e)} except Exception as e: logger.error(f"Unexpected error updating workflow activity: {e}") return {"error": str(e)}
- Pydantic model defining the input parameters for the update_workflow_activity tool, including activity_id (required), optional name, description, and attributes.class UpdateWorkflowActivityParams(BaseModel): """Parameters for updating a workflow activity.""" activity_id: str = Field(..., description="Activity ID or sys_id") name: Optional[str] = Field(None, description="Name of the activity") description: Optional[str] = Field(None, description="Description of the activity") attributes: Optional[Dict[str, Any]] = Field(None, description="Additional attributes for the activity")
- src/servicenow_mcp/utils/tool_utils.py:599-605 (registration)Tool registration in the central tool_definitions dictionary. Maps the tool name to its handler (aliased import), schema, return type hint, description, and serialization method for MCP server integration."update_workflow_activity": ( update_workflow_activity_tool, UpdateWorkflowActivityParams, str, # Expects JSON string "Update an existing activity in a workflow", "json_dict", # Tool returns Pydantic model ),