add_file_to_changeset

Add files to ServiceNow changesets by specifying file paths and content. This tool enables developers to manage code changes and documentation within ServiceNow development workflows.

Instructions

Add a file to a changeset in ServiceNow

Input Schema

TableJSON Schema

Name	Required	Description
`changeset_id`	Yes	Changeset ID or sys_id
`file_path`	Yes	Path of the file to add
`file_content`	Yes	Content of the file

Implementation Reference

src/servicenow_mcp/tools/changeset_tools.py:694-768 (handler)

Implements the core logic for adding a file to a ServiceNow changeset by posting to the sys_update_xml table with the file path, content, and linking to the 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)}",
        }

src/servicenow_mcp/tools/changeset_tools.py:73-79 (schema)

Pydantic model defining the input parameters for the add_file_to_changeset tool: changeset_id, file_path, file_content.

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:617-623 (registration)
Registers the 'add_file_to_changeset' tool in the get_tool_definitions dictionary, mapping the imported function, params schema, return type, description, and serialization method.
```
"add_file_to_changeset": (
    add_file_to_changeset_tool,
    AddFileToChangesetParams,
    str,
    "Add a file to a changeset in ServiceNow",
    "str",  # Tool returns simple message
),
```

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

Re-exports the add_file_to_changeset function from changeset_tools for use in the tools package.

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

src/servicenow_mcp/utils/tool_utils.py:98-99 (registration)
Imports the add_file_to_changeset function (aliased as _tool) and AddFileToChangesetParams from changeset_tools for registration in tool definitions.
```
from servicenow_mcp.tools.changeset_tools import (
    add_file_to_changeset as add_file_to_changeset_tool,
```

ServiceNow MCP Server