approve_change
Utilize this tool to approve change requests in ServiceNow by specifying the change ID, approver ID, and optional approval comments. Streamlines the change management process efficiently.
Instructions
Approve a change request
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| approval_comments | No | Comments for the approval | |
| approver_id | No | ID of the approver | |
| change_id | Yes | Change request ID or sys_id |
Implementation Reference
- Main handler function executing the approve_change tool logic by validating params, querying approval records, updating approval to 'approved', and advancing change request state to 'implement' via ServiceNow REST API.def approve_change( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Approve a change request in ServiceNow. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for approving a change request. Returns: The result of the approval. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, ApproveChangeParams, required_fields=["change_id"] ) if not result["success"]: return result validated_params = result["params"] # Get the instance URL instance_url = _get_instance_url(auth_manager, server_config) if not instance_url: return { "success": False, "message": "Cannot find instance_url in either server_config or auth_manager", } # Get the headers headers = _get_headers(auth_manager, server_config) if not headers: return { "success": False, "message": "Cannot find get_headers method in either auth_manager or server_config", } # First, find the approval record approval_query_url = f"{instance_url}/api/now/table/sysapproval_approver" query_params = { "sysparm_query": f"document_id={validated_params.change_id}", "sysparm_limit": 1, } try: approval_response = requests.get(approval_query_url, headers=headers, params=query_params) approval_response.raise_for_status() approval_result = approval_response.json() if not approval_result.get("result") or len(approval_result["result"]) == 0: return { "success": False, "message": "No approval record found for this change request", } approval_id = approval_result["result"][0]["sys_id"] # Now, update the approval record to approved approval_update_url = f"{instance_url}/api/now/table/sysapproval_approver/{approval_id}" headers["Content-Type"] = "application/json" approval_data = { "state": "approved", } if validated_params.approval_comments: approval_data["comments"] = validated_params.approval_comments approval_update_response = requests.patch(approval_update_url, json=approval_data, headers=headers) approval_update_response.raise_for_status() # Finally, update the change request state to "implement" change_url = f"{instance_url}/api/now/table/change_request/{validated_params.change_id}" change_data = { "state": "implement", # This may vary depending on ServiceNow configuration } change_response = requests.patch(change_url, json=change_data, headers=headers) change_response.raise_for_status() return { "success": True, "message": "Change request approved successfully", } except requests.exceptions.RequestException as e: logger.error(f"Error approving change: {e}") return { "success": False, "message": f"Error approving change: {str(e)}", }
- Pydantic model defining input parameters for the approve_change tool, including required change_id and optional approver_id and comments.class ApproveChangeParams(BaseModel): """Parameters for approving a change request.""" change_id: str = Field(..., description="Change request ID or sys_id") approver_id: Optional[str] = Field(None, description="ID of the approver") approval_comments: Optional[str] = Field(None, description="Comments for the approval")
- src/servicenow_mcp/utils/tool_utils.py:475-481 (registration)MCP tool registration in get_tool_definitions(), mapping 'approve_change' to its handler, input schema, return type, description, and serialization method."approve_change": ( approve_change_tool, ApproveChangeParams, str, "Approve a change request", "str", # Tool returns simple message ),
- src/servicenow_mcp/tools/__init__.py:23-32 (registration)Import and re-export of approve_change function from change_tools.py in the tools package __init__ for easy access.from servicenow_mcp.tools.change_tools import ( add_change_task, approve_change, create_change_request, get_change_request_details, list_change_requests, reject_change, submit_change_for_approval, update_change_request, )
- src/servicenow_mcp/tools/__init__.py:124-126 (registration)Inclusion of 'approve_change' in __all__ for package-level export."approve_change", "reject_change",