ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/change_tools.py:209-300 (handler)

  The main handler function that executes the create_change_request tool logic. It validates input parameters using Pydantic, prepares the data, makes a POST request to ServiceNow's change_request table API, and returns the result.
  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)}", }
• src/servicenow_mcp/tools/change_tools.py:23-36 (schema)

  Pydantic BaseModel defining the input schema and validation for the create_change_request tool parameters.
  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:433-439 (registration)

  Registration of the 'create_change_request' tool in the central tool_definitions dictionary, mapping the tool name to its handler function alias, input schema, return type hint, description, and serialization method.
  "create_change_request": ( create_change_request_tool, CreateChangeRequestParams, str, "Create a new change request in ServiceNow", "str", ),
• src/servicenow_mcp/tools/__init__.py:23-32 (registration)

  Re-export of create_change_request from change_tools.py in the tools package __init__.py 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/change_tools.py:181-207 (helper)

  Helper function used by the handler to flexibly retrieve authentication headers from either auth_manager or server_config, handling potential parameter order swaps.
  def _get_headers(auth_manager: Any, server_config: Any) -> Optional[Dict[str, str]]: """ Helper function to get headers from either auth_manager or server_config. Args: auth_manager: The authentication manager or object passed as auth_manager. server_config: The server configuration or object passed as server_config. Returns: The headers if found, None otherwise. """ # Try to get headers from auth_manager if hasattr(auth_manager, 'get_headers'): return auth_manager.get_headers() # If auth_manager doesn't have get_headers, try server_config if hasattr(server_config, 'get_headers'): return server_config.get_headers() # If neither has get_headers, check if auth_manager is actually a ServerConfig # and server_config is actually an AuthManager (parameters swapped) if hasattr(server_config, 'get_headers') and not hasattr(auth_manager, 'get_headers'): return server_config.get_headers() logger.error("Cannot find get_headers method in either auth_manager or server_config") return None