ServiceNow MCP Server

Instructions

Implementation Reference

• src/servicenow_mcp/tools/changeset_tools.py:449-536 (handler)

  The main handler function that implements the update_changeset tool logic, including parameter validation, API call to patch the changeset, and error handling.

  def update_changeset(
      auth_manager: AuthManager,
      server_config: ServerConfig,
      params: Union[Dict[str, Any], UpdateChangesetParams],
  ) -> Dict[str, Any]:
      """
      Update an existing changeset in ServiceNow.
  
      Args:
          auth_manager: The authentication manager.
          server_config: The server configuration.
          params: The parameters for updating a changeset. Can be a dictionary or a UpdateChangesetParams object.
  
      Returns:
          The updated changeset.
      """
      # Unwrap and validate parameters
      result = _unwrap_and_validate_params(
          params, 
          UpdateChangesetParams, 
          required_fields=["changeset_id"]
      )
      
      if not result["success"]:
          return result
      
      validated_params = result["params"]
      
      # Prepare the request data
      data = {}
      
      # Add optional fields if provided
      if validated_params.name:
          data["name"] = validated_params.name
      if validated_params.description:
          data["description"] = validated_params.description
      if validated_params.state:
          data["state"] = validated_params.state
      if validated_params.developer:
          data["developer"] = validated_params.developer
      
      # If no fields to update, return error
      if not data:
          return {
              "success": False,
              "message": "No fields to update",
          }
      
      # 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/sys_update_set/{validated_params.changeset_id}"
      
      try:
          response = requests.patch(url, json=data, headers=headers)
          response.raise_for_status()
          
          result = response.json()
          
          return {
              "success": True,
              "message": "Changeset updated successfully",
              "changeset": result["result"],
          }
      except requests.exceptions.RequestException as e:
          logger.error(f"Error updating changeset: {e}")
          return {
              "success": False,
              "message": f"Error updating changeset: {str(e)}",
          }

• src/servicenow_mcp/tools/changeset_tools.py:49-57 (schema)

  Pydantic model defining the input parameters for the update_changeset tool.

  class UpdateChangesetParams(BaseModel):
      """Parameters for updating a changeset."""
  
      changeset_id: str = Field(..., description="Changeset ID or sys_id")
      name: Optional[str] = Field(None, description="Name of the changeset")
      description: Optional[str] = Field(None, description="Description of the changeset")
      state: Optional[str] = Field(None, description="State of the changeset")
      developer: Optional[str] = Field(None, description="Developer responsible for the changeset")

• src/servicenow_mcp/utils/tool_utils.py:653-659 (registration)

  Registration of the update_changeset tool in the get_tool_definitions dictionary, specifying the handler alias, schema, return type hint, description, and serialization method.

  "update_changeset": (
      update_changeset_tool,
      UpdateChangesetParams,
      str,  # Expects JSON string
      "Update an existing changeset in ServiceNow",
      "json_dict",  # Tool returns Pydantic model
  ),

• src/servicenow_mcp/tools/__init__.py:33-41 (registration)

  Import of update_changeset function from changeset_tools, exposing it in the tools namespace.

  from servicenow_mcp.tools.changeset_tools import (
      add_file_to_changeset,
      commit_changeset,
      create_changeset,
      get_changeset_details,
      list_changesets,
      publish_changeset,
      update_changeset,
  )