publish_changeset
Publish a ServiceNow changeset to deploy configuration updates from development to production environments, with optional notes for tracking.
Instructions
Publish a changeset in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| changeset_id | Yes | Changeset ID or sys_id | |
| publish_notes | No | Notes for publishing |
Implementation Reference
- The main handler function that executes the publish_changeset tool. It validates parameters, retrieves instance URL and headers, prepares a PATCH request to set the changeset state to 'published', and returns success or error details.
def publish_changeset( auth_manager: AuthManager, server_config: ServerConfig, params: Union[Dict[str, Any], PublishChangesetParams], ) -> Dict[str, Any]: """ Publish a changeset in ServiceNow. Args: auth_manager: The authentication manager. server_config: The server configuration. params: The parameters for publishing a changeset. Can be a dictionary or a PublishChangesetParams object. Returns: The published changeset. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, PublishChangesetParams, required_fields=["changeset_id"] ) 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 the publish action data = { "state": "published", } # Add publish notes if provided if validated_params.publish_notes: data["description"] = validated_params.publish_notes # 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 published successfully", "changeset": result["result"], } except requests.exceptions.RequestException as e: logger.error(f"Error publishing changeset: {e}") return { "success": False, "message": f"Error publishing changeset: {str(e)}", } - Pydantic BaseModel defining the input schema for the publish_changeset tool, with required 'changeset_id' and optional 'publish_notes' fields.
class PublishChangesetParams(BaseModel): """Parameters for publishing a changeset.""" changeset_id: str = Field(..., description="Changeset ID or sys_id") publish_notes: Optional[str] = Field(None, description="Notes for publishing") - src/servicenow_mcp/utils/tool_utils.py:656-662 (registration)Registration of the 'publish_changeset' tool in the central tool_definitions dictionary used by the MCP server. Maps the tool name to its handler (publish_changeset_tool), input schema (PublishChangesetParams), return type (str), description, and serialization method.
"publish_changeset": ( publish_changeset_tool, PublishChangesetParams, str, "Publish a changeset in ServiceNow", "str", # Tool returns simple message ),