ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/scrum_task_tools.py:263-357 (handler)

  The core handler function that executes the 'update_scrum_task' tool. It validates input parameters using UpdateScrumTaskParams, prepares a PUT request to the ServiceNow rm_scrum_task table API, and returns the result.

  def update_scrum_task(
      auth_manager: AuthManager,
      server_config: ServerConfig,
      params: Dict[str, Any],
  ) -> Dict[str, Any]:
      """
      Update an existing scrum task in ServiceNow.
  
      Args:
          auth_manager: The authentication manager.
          server_config: The server configuration.
          params: The parameters for updating the scrum task.
  
      Returns:
          The updated scrum task.
      """
      # Unwrap and validate parameters
      result = _unwrap_and_validate_params(
          params, 
          UpdateScrumTaskParams,
          required_fields=["scrum_task_id"]
      )
      
      if not result["success"]:
          return result
      
      validated_params = result["params"]
      
      # Prepare the request data
      data = {}
  
      # Add optional fields if provided
      if validated_params.short_description:
          data["short_description"] = validated_params.short_description
      if validated_params.priority:
          data["priority"] = validated_params.priority
      if validated_params.planned_hours:
          data["planned_hours"] = validated_params.planned_hours
      if validated_params.remaining_hours:
          data["remaining_hours"] = validated_params.remaining_hours
      if validated_params.hours:
          data["hours"] = validated_params.hours
      if validated_params.description:
          data["description"] = validated_params.description
      if validated_params.type:
          data["type"] = validated_params.type
      if validated_params.state:
          data["state"] = validated_params.state
      if validated_params.assignment_group:
          data["assignment_group"] = validated_params.assignment_group
      if validated_params.assigned_to:
          data["assigned_to"] = validated_params.assigned_to
      if validated_params.work_notes:
          data["work_notes"] = validated_params.work_notes
      
      # 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/rm_scrum_task/{validated_params.scrum_task_id}"
      
      try:
          response = requests.put(url, json=data, headers=headers)
          response.raise_for_status()
          
          result = response.json()
          
          return {
              "success": True,
              "message": "Scrum Task updated successfully",
              "scrum_task": result["result"],
          }
      except requests.exceptions.RequestException as e:
          logger.error(f"Error updating scrum task: {e}")
          return {
              "success": False,
              "message": f"Error updating scrum task: {str(e)}",
          }

• src/servicenow_mcp/tools/scrum_task_tools.py:38-52 (schema)

  Pydantic model defining the input schema/parameters for the update_scrum_task tool, including required scrum_task_id and various optional fields for updating the task.

  class UpdateScrumTaskParams(BaseModel):
      """Parameters for updating a scrum task."""
  
      scrum_task_id: str = Field(..., description="Scrum Task ID or sys_id")
      short_description: Optional[str] = Field(None, description="Short description of the scrum task")
      priority: Optional[str] = Field(None, description="Priority of scrum task (1 is Critical, 2 is High, 3 is Moderate, 4 is Low)")
      planned_hours: Optional[int] = Field(None, description="Planned hours for the scrum task")
      remaining_hours: Optional[int] = Field(None, description="Remaining hours for the scrum task")
      hours: Optional[int] = Field(None, description="Actual Hours for the scrum task")
      description: Optional[str] = Field(None, description="Detailed description of the scrum task")
      type: Optional[str] = Field(None, description="Type of scrum task (1 is Analysis, 2 is Coding, 3 is Documentation, 4 is Testing)")
      state: Optional[str] = Field(None, description="State of scrum task (-6 is Draft,1 is Ready, 2 is Work in progress, 3 is Complete, 4 is Cancelled)")
      assignment_group: Optional[str] = Field(None, description="Group assigned to the scrum task")
      assigned_to: Optional[str] = Field(None, description="User assigned to the scrum task")
      work_notes: Optional[str] = Field(None, description="Work notes to add to the scrum task")

• src/servicenow_mcp/utils/tool_utils.py:909-915 (registration)

  The tool registration entry in get_tool_definitions() dictionary, mapping 'update_scrum_task' to its handler (aliased import), schema, return type, description, and serialization method.

  "update_scrum_task": (
      update_scrum_task_tool,
      UpdateScrumTaskParams,
      str,
      "Update an existing scrum task in ServiceNow",
      "str",
  ),

• src/servicenow_mcp/utils/tool_utils.py:316-325 (registration)

  Import statements that bring in the handler function (aliased as update_scrum_task_tool) and schema (UpdateScrumTaskParams) from scrum_task_tools.py for use in tool registration.

  from servicenow_mcp.tools.scrum_task_tools import (
      CreateScrumTaskParams,
      UpdateScrumTaskParams,
      ListScrumTasksParams,
  )
  from servicenow_mcp.tools.scrum_task_tools import (
      create_scrum_task as create_scrum_task_tool,
      update_scrum_task as update_scrum_task_tool,
      list_scrum_tasks as list_scrum_tasks_tool,
  )