Utils API

Utility functions and helper modules.

Common Utilities

The utils module provides common utility functions used across the MCP server.

User Agent Generation

The get_combined_user_agent function generates a custom user agent string for API requests.

Logging Utilities

Logging configuration for Zscaler Integrations MCP Server

This module provides logging utilities for the Zscaler Integrations MCP Server.

configure_logging(debug=False, name='zscaler_mcp', use_stderr=False)

Configure logging for the Zscaler Integrations MCP Server.

Parameters:

• debug – Enable debug logging

• name – Logger name

• use_stderr – Use stderr for logging (recommended for stdio transport)

Returns:

Configured logger

Return type:

logging.Logger

get_logger(name=None)

Get a logger with the specified name.

Parameters:

name – Logger name (defaults to “zscaler_mcp”)

Returns:

Logger instance

Return type:

logging.Logger

log_security_warning(title, details)

Log a prominent security warning banner.

Used across modules (server.py, auth.py) to display standardized security warnings when protective features are disabled.

Configuration Utilities

Helper functions for configuration management and validation.

Data Processing Utilities

Common data processing and transformation functions.

Usage Examples

User Agent Generation

from zscaler_mcp.utils.utils import get_combined_user_agent

# Generate custom user agent
user_agent = get_combined_user_agent()
print(user_agent)

Logging Setup

from zscaler_mcp.common.logging import setup_logging

# Setup logging with custom configuration
setup_logging(level="DEBUG", format="detailed")