ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/change_tools.py:584-667 (handler)

  The core handler function for the 'add_change_task' tool. It validates input parameters against AddChangeTaskParams, constructs the payload for creating a change task, retrieves instance URL and headers, and performs a POST request to the ServiceNow '/api/now/table/change_task' endpoint.

  def add_change_task(
      auth_manager: AuthManager,
      server_config: ServerConfig,
      params: Dict[str, Any],
  ) -> Dict[str, Any]:
      """
      Add a task to a change request in ServiceNow.
  
      Args:
          auth_manager: The authentication manager.
          server_config: The server configuration.
          params: The parameters for adding a change task.
  
      Returns:
          The created change task.
      """
      # Unwrap and validate parameters
      result = _unwrap_and_validate_params(
          params, 
          AddChangeTaskParams,
          required_fields=["change_id", "short_description"]
      )
      
      if not result["success"]:
          return result
      
      validated_params = result["params"]
      
      # Prepare the request data
      data = {
          "change_request": validated_params.change_id,
          "short_description": validated_params.short_description,
      }
      
      # Add optional fields if provided
      if validated_params.description:
          data["description"] = validated_params.description
      if validated_params.assigned_to:
          data["assigned_to"] = validated_params.assigned_to
      if validated_params.planned_start_date:
          data["planned_start_date"] = validated_params.planned_start_date
      if validated_params.planned_end_date:
          data["planned_end_date"] = validated_params.planned_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_task"
      
      try:
          response = requests.post(url, json=data, headers=headers)
          response.raise_for_status()
          
          result = response.json()
          
          return {
              "success": True,
              "message": "Change task added successfully",
              "change_task": result["result"],
          }
      except requests.exceptions.RequestException as e:
          logger.error(f"Error adding change task: {e}")
          return {
              "success": False,
              "message": f"Error adding change task: {str(e)}",
          }

• src/servicenow_mcp/tools/change_tools.py:73-82 (schema)

  Pydantic BaseModel schema defining the input parameters for the add_change_task tool, including required fields like change_id and short_description, and optional fields like description, assigned_to, planned dates.

  class AddChangeTaskParams(BaseModel):
      """Parameters for adding a task to a change request."""
  
      change_id: str = Field(..., description="Change request ID or sys_id")
      short_description: str = Field(..., description="Short description of the task")
      description: Optional[str] = Field(None, description="Detailed description of the task")
      assigned_to: Optional[str] = Field(None, description="User assigned to the task")
      planned_start_date: Optional[str] = Field(None, description="Planned start date (YYYY-MM-DD HH:MM:SS)")
      planned_end_date: Optional[str] = Field(None, description="Planned end date (YYYY-MM-DD HH:MM:SS)")

• src/servicenow_mcp/utils/tool_utils.py:518-524 (registration)

  Registers the 'add_change_task' tool in the central tool_definitions dictionary used by the MCP server. Associates the handler function (add_change_task_tool), input schema (AddChangeTaskParams), expected input type (str/JSON), description, and output serialization method ('json_dict').

  "add_change_task": (
      add_change_task_tool,
      AddChangeTaskParams,
      str,  # Expects JSON string
      "Add a task to a change request",
      "json_dict",  # Tool returns Pydantic model
  ),

• src/servicenow_mcp/tools/__init__.py:23-32 (registration)

  Imports the add_change_task handler from change_tools.py into the tools package namespace, making it available for re-export and use in higher-level registrations.

  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:146-146 (registration)

  Explicitly includes 'add_change_task' in the __all__ list, ensuring it is exported when the tools package is imported with 'from servicenow_mcp.tools import *'.

  "add_change_task",