update_epic

Instructions

Implementation Reference

• src/servicenow_mcp/tools/epic_tools.py:243-326 (handler)

  The main handler function that implements the logic for the 'update_epic' tool. It validates parameters using UpdateEpicParams, prepares update data, and sends a PUT request to the ServiceNow rm_epic table API endpoint.

  def update_epic(
      auth_manager: AuthManager,
      server_config: ServerConfig,
      params: Dict[str, Any],
  ) -> Dict[str, Any]:
      """
      Update an existing epic in ServiceNow.
  
      Args:
          auth_manager: The authentication manager.
          server_config: The server configuration.
          params: The parameters for updating the epic.
  
      Returns:
          The updated epic.
      """
      # Unwrap and validate parameters
      result = _unwrap_and_validate_params(
          params, 
          UpdateEpicParams,
          required_fields=["epic_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.description:
          data["description"] = validated_params.description
      if validated_params.priority:
          data["priority"] = validated_params.priority
      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_epic/{validated_params.epic_id}"
      
      try:
          response = requests.put(url, json=data, headers=headers)
          response.raise_for_status()
          
          result = response.json()
          
          return {
              "success": True,
              "message": "Epic updated successfully",
              "epic": result["result"],
          }
      except requests.exceptions.RequestException as e:
          logger.error(f"Error updating epic: {e}")
          return {
              "success": False,
              "message": f"Error updating epic: {str(e)}",
          }

• src/servicenow_mcp/tools/epic_tools.py:33-43 (schema)

  Pydantic BaseModel defining the input schema/parameters for the update_epic tool, including required epic_id and optional fields for updating epic properties.

  class UpdateEpicParams(BaseModel):
      """Parameters for updating an epic."""
  
      epic_id: str = Field(..., description="Epic ID or sys_id")
      short_description: Optional[str] = Field(None, description="Short description of the epic")
      description: Optional[str] = Field(None, description="Detailed description of the epic")
      priority: Optional[str] = Field(None, description="Priority of epic (1 is Critical, 2 is High, 3 is Moderate, 4 is Low, 5 is Planning)")
      state: Optional[str] = Field(None, description="State of story (-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 epic")
      assigned_to: Optional[str] = Field(None, description="User assigned to the epic")
      work_notes: Optional[str] = Field(None, description="Work notes to add to the epic. Used for adding notes and comments to an epic")

• src/servicenow_mcp/utils/tool_utils.py:887-893 (registration)

  Registration of the 'update_epic' tool in the central tool_definitions dictionary within get_tool_definitions function, mapping name to (handler function alias, params schema, return type, description, serialization).

  "update_epic": (
      update_epic_tool,
      UpdateEpicParams,
      str,
      "Update an existing epic in ServiceNow",
      "str",
  ),

• src/servicenow_mcp/tools/__init__.py:100-104 (registration)

  Import and re-export of the update_epic handler function from epic_tools.py in the tools package __init__.

  from servicenow_mcp.tools.epic_tools import (
      create_epic,
      update_epic,
      list_epics,
  )

• src/servicenow_mcp/utils/tool_utils.py:312-315 (registration)

  Import of update_epic function aliased as update_epic_tool and UpdateEpicParams schema for use in tool registration.

      create_epic as create_epic_tool,
      update_epic as update_epic_tool,
      list_epics as list_epics_tool,
  )