get_changeset_details
Retrieve detailed information about a specific ServiceNow changeset using its ID, including status, changes, and related data for tracking and analysis.
Instructions
Get detailed information about a specific changeset
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| changeset_id | Yes | Changeset ID or sys_id |
Implementation Reference
- The core handler function that retrieves detailed information about a specific changeset by querying the ServiceNow API for both the changeset and its associated changes.def get_changeset_details( auth_manager: AuthManager, server_config: ServerConfig, params: Union[Dict[str, Any], GetChangesetDetailsParams], ) -> Dict[str, Any]: """ Get detailed information about a specific changeset. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for getting changeset details. Can be a dictionary or a GetChangesetDetailsParams object. Returns: Detailed information about the changeset. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, GetChangesetDetailsParams, required_fields=["changeset_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", } # Make the API request url = f"{instance_url}/api/now/table/sys_update_set/{validated_params.changeset_id}" try: response = requests.get(url, headers=headers) response.raise_for_status() result = response.json() # Get the changeset details changeset = result.get("result", {}) # Get the changes in this changeset changes_url = f"{instance_url}/api/now/table/sys_update_xml" changes_params = { "sysparm_query": f"update_set={validated_params.changeset_id}", } changes_response = requests.get(changes_url, params=changes_params, headers=headers) changes_response.raise_for_status() changes_result = changes_response.json() changes = changes_result.get("result", []) return { "success": True, "changeset": changeset, "changes": changes, "change_count": len(changes), } except requests.exceptions.RequestException as e: logger.error(f"Error getting changeset details: {e}") return { "success": False, "message": f"Error getting changeset details: {str(e)}", }
- Pydantic BaseModel defining the input schema for the get_changeset_details tool, requiring a changeset_id.class GetChangesetDetailsParams(BaseModel): """Parameters for getting changeset details.""" changeset_id: str = Field(..., description="Changeset ID or sys_id")
- src/servicenow_mcp/utils/tool_utils.py:628-634 (registration)Registration of the tool in the central get_tool_definitions dictionary, mapping the tool name to its implementation, params schema, description, and serialization details."get_changeset_details": ( get_changeset_details_tool, GetChangesetDetailsParams, str, # Expects JSON string "Get detailed information about a specific changeset", "json", # Tool returns list/dict ),
- src/servicenow_mcp/utils/tool_utils.py:107-109 (registration)Import and alias of the handler function for use in tool registration.from servicenow_mcp.tools.changeset_tools import ( get_changeset_details as get_changeset_details_tool, )
- src/servicenow_mcp/tools/__init__.py:37-37 (registration)Export of the tool function via __init__.py to make it available in the tools namespace.get_changeset_details,