add_file_to_changeset
Add a file to a ServiceNow changeset by specifying the changeset ID, file path, and content. Facilitates updates to changeset configurations efficiently.
Instructions
Add a file to a changeset in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Implementation Reference
- The core handler function that executes the tool logic: validates params, makes POST request to ServiceNow's sys_update_xml table to add the file to the specified changeset.
def add_file_to_changeset( auth_manager: AuthManager, server_config: ServerConfig, params: Union[Dict[str, Any], AddFileToChangesetParams], ) -> Dict[str, Any]: """ Add a file to a changeset in ServiceNow. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for adding a file to a changeset. Can be a dictionary or a AddFileToChangesetParams object. Returns: The result of the add file operation. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, AddFileToChangesetParams, required_fields=["changeset_id", "file_path", "file_content"] ) if not result["success"]: return result validated_params = result["params"] # 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" # Prepare the request data for adding a file data = { "update_set": validated_params.changeset_id, "name": validated_params.file_path, "payload": validated_params.file_content, "type": "file", } # Make the API request url = f"{instance_url}/api/now/table/sys_update_xml" try: response = requests.post(url, json=data, headers=headers) response.raise_for_status() result = response.json() return { "success": True, "message": "File added to changeset successfully", "file": result["result"], } except requests.exceptions.RequestException as e: logger.error(f"Error adding file to changeset: {e}") return { "success": False, "message": f"Error adding file to changeset: {str(e)}", } - Pydantic BaseModel defining the input schema (parameters) for the add_file_to_changeset tool.
class AddFileToChangesetParams(BaseModel): """Parameters for adding a file to a changeset.""" changeset_id: str = Field(..., description="Changeset ID or sys_id") file_path: str = Field(..., description="Path of the file to add") file_content: str = Field(..., description="Content of the file") - src/servicenow_mcp/utils/tool_utils.py:674-680 (registration)Tool registration entry in get_tool_definitions() dictionary, mapping name to (handler, schema, return_type, description, serialization). This is used by the MCP server to expose the tool.
"add_file_to_changeset": ( add_file_to_changeset_tool, AddFileToChangesetParams, str, "Add a file to a changeset in ServiceNow", "str", # Tool returns simple message ),