list_change_requests
Retrieve and filter change requests from ServiceNow to monitor, track, and manage IT infrastructure modifications.
Instructions
List change requests from ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of records to return | |
| offset | No | Offset to start from | |
| state | No | Filter by state | |
| type | No | Filter by type (normal, standard, emergency) | |
| category | No | Filter by category | |
| assignment_group | No | Filter by assignment group | |
| timeframe | No | Filter by timeframe (upcoming, in-progress, completed) | |
| query | No | Additional query string |
Implementation Reference
- The main handler function that implements the list_change_requests tool logic. It validates parameters using ListChangeRequestsParams, builds a ServiceNow Table API query based on filters, fetches change requests via GET /api/now/table/change_request, and returns the list with success status.def list_change_requests( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ List change requests from ServiceNow. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for listing change requests. Returns: A list of change requests. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, ListChangeRequestsParams ) if not result["success"]: return result validated_params = result["params"] # Build the query query_parts = [] if validated_params.state: query_parts.append(f"state={validated_params.state}") if validated_params.type: query_parts.append(f"type={validated_params.type}") if validated_params.category: query_parts.append(f"category={validated_params.category}") if validated_params.assignment_group: query_parts.append(f"assignment_group={validated_params.assignment_group}") # Handle timeframe filtering if validated_params.timeframe: now = datetime.now().strftime("%Y-%m-%d %H:%M:%S") if validated_params.timeframe == "upcoming": query_parts.append(f"start_date>{now}") elif validated_params.timeframe == "in-progress": query_parts.append(f"start_date<{now}^end_date>{now}") elif validated_params.timeframe == "completed": query_parts.append(f"end_date<{now}") # Add any additional query string if validated_params.query: query_parts.append(validated_params.query) # Combine query parts query = "^".join(query_parts) if query_parts else "" # 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/change_request" params = { "sysparm_limit": validated_params.limit, "sysparm_offset": validated_params.offset, "sysparm_query": query, "sysparm_display_value": "true", } try: response = requests.get(url, headers=headers, params=params) response.raise_for_status() result = response.json() # Handle the case where result["result"] is a list change_requests = result.get("result", []) count = len(change_requests) return { "success": True, "change_requests": change_requests, "count": count, "total": count, # Use count as total if total is not provided } except requests.exceptions.RequestException as e: logger.error(f"Error listing change requests: {e}") return { "success": False, "message": f"Error listing change requests: {str(e)}", }
- Pydantic model defining the input parameters for the list_change_requests tool, including pagination (limit, offset), filters (state, type, category, etc.), and custom query.class ListChangeRequestsParams(BaseModel): """Parameters for listing change requests.""" limit: Optional[int] = Field(10, description="Maximum number of records to return") offset: Optional[int] = Field(0, description="Offset to start from") state: Optional[str] = Field(None, description="Filter by state") type: Optional[str] = Field(None, description="Filter by type (normal, standard, emergency)") category: Optional[str] = Field(None, description="Filter by category") assignment_group: Optional[str] = Field(None, description="Filter by assignment group") timeframe: Optional[str] = Field(None, description="Filter by timeframe (upcoming, in-progress, completed)") query: Optional[str] = Field(None, description="Additional query string")
- src/servicenow_mcp/utils/tool_utils.py:447-453 (registration)MCP tool registration in get_tool_definitions(). Maps 'list_change_requests' to the aliased handler (list_change_requests_tool), input schema (ListChangeRequestsParams), description, and serialization ('json')."list_change_requests": ( list_change_requests_tool, ListChangeRequestsParams, str, # Expects JSON string "List change requests from ServiceNow", "json", # Tool returns list/dict ),
- src/servicenow_mcp/tools/__init__.py:28-28 (registration)Import of list_change_requests function from change_tools.py into the tools module namespace.list_change_requests,
- src/servicenow_mcp/utils/tool_utils.py:78-78 (registration)Import alias for the handler function used in MCP tool registration (list_change_requests_tool).list_change_requests as list_change_requests_tool,