create_change_request
Create a new change request in ServiceNow to manage IT infrastructure modifications, including type, risk, impact, and scheduling details.
Instructions
Create a new change request in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| short_description | Yes | Short description of the change request | |
| description | No | Detailed description of the change request | |
| type | Yes | Type of change (normal, standard, emergency) | |
| risk | No | Risk level of the change | |
| impact | No | Impact of the change | |
| category | No | Category of the change | |
| requested_by | No | User who requested the change | |
| assignment_group | No | Group assigned to the change | |
| start_date | No | Planned start date (YYYY-MM-DD HH:MM:SS) | |
| end_date | No | Planned end date (YYYY-MM-DD HH:MM:SS) |
Implementation Reference
- The handler function that executes the create_change_request tool. It validates input parameters using CreateChangeRequestParams, prepares the payload, authenticates via auth_manager and server_config, and posts to ServiceNow's change_request table API.def create_change_request( auth_manager: AuthManager, server_config: ServerConfig, params: Dict[str, Any], ) -> Dict[str, Any]: """ Create a new change request in ServiceNow. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for creating the change request. Returns: The created change request. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, CreateChangeRequestParams, required_fields=["short_description", "type"] ) if not result["success"]: return result validated_params = result["params"] # Prepare the request data data = { "short_description": validated_params.short_description, "type": validated_params.type, } # Add optional fields if provided if validated_params.description: data["description"] = validated_params.description if validated_params.risk: data["risk"] = validated_params.risk if validated_params.impact: data["impact"] = validated_params.impact if validated_params.category: data["category"] = validated_params.category if validated_params.requested_by: data["requested_by"] = validated_params.requested_by if validated_params.assignment_group: data["assignment_group"] = validated_params.assignment_group if validated_params.start_date: data["start_date"] = validated_params.start_date if validated_params.end_date: data["end_date"] = validated_params.end_date # 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", } # Add Content-Type header headers["Content-Type"] = "application/json" # Make the API request url = f"{instance_url}/api/now/table/change_request" try: response = requests.post(url, json=data, headers=headers) response.raise_for_status() result = response.json() return { "success": True, "message": "Change request created successfully", "change_request": result["result"], } except requests.exceptions.RequestException as e: logger.error(f"Error creating change request: {e}") return { "success": False, "message": f"Error creating change request: {str(e)}", }
- Pydantic model defining the input schema for the create_change_request tool, including required fields like short_description and type, and optional fields like description, risk, etc.class CreateChangeRequestParams(BaseModel): """Parameters for creating a change request.""" short_description: str = Field(..., description="Short description of the change request") description: Optional[str] = Field(None, description="Detailed description of the change request") type: str = Field(..., description="Type of change (normal, standard, emergency)") risk: Optional[str] = Field(None, description="Risk level of the change") impact: Optional[str] = Field(None, description="Impact of the change") category: Optional[str] = Field(None, description="Category of the change") requested_by: Optional[str] = Field(None, description="User who requested the change") assignment_group: Optional[str] = Field(None, description="Group assigned to the change") start_date: Optional[str] = Field(None, description="Planned start date (YYYY-MM-DD HH:MM:SS)") end_date: Optional[str] = Field(None, description="Planned end date (YYYY-MM-DD HH:MM:SS)")
- src/servicenow_mcp/utils/tool_utils.py:479-485 (registration)Registers the create_change_request tool in the get_tool_definitions dictionary, mapping the tool name to its handler function (aliased), input schema (CreateChangeRequestParams), return type, description, and serialization method."create_change_request": ( create_change_request_tool, CreateChangeRequestParams, str, "Create a new change request in ServiceNow", "str", ),