firewalla-mcp-server/dist/config/response-config.d.ts

Model Context Protocol (MCP) server for Firewalla MSP API - Provides real-time network monitoring, security analysis, and firewall management through 28 specialized tools compatible with any MCP client

/**
 * Response format configuration for gradual migration to standardized formats
 *
 * This configuration allows for controlled rollout of response format standardization
 * while maintaining backward compatibility for existing integrations.
 */
/**
 * Response format configuration interface
 */
export interface ResponseFormatConfig {
    /** Enable standardized response formats globally */
    useStandardFormats: boolean;
    /** Legacy compatibility settings */
    legacyCompatibility: {
        /** Enable legacy format support */
        enabled: boolean;
        /** List of tools that should continue using legacy formats */
        toolsUsingLegacyFormat: string[];
        /** Migration deadline (after which legacy support may be removed) */
        migrationDeadline?: string;
        /** Warnings for deprecated formats */
        showDeprecationWarnings: boolean;
    };
    /** Metadata inclusion settings */
    includeMetadata: {
        /** Include execution timing information */
        executionTime: boolean;
        /** Include cache status information */
        cacheStatus: boolean;
        /** Include query optimization details */
        queryOptimizations: boolean;
        /** Include statistical summary information */
        statisticalSummary: boolean;
        /** Include pagination metadata */
        paginationDetails: boolean;
    };
    /** Performance settings */
    performance: {
        /** Enable response compression for large datasets */
        enableCompression: boolean;
        /** Maximum response size before pagination is enforced */
        maxResponseSize: number;
        /** Enable response caching */
        enableCaching: boolean;
    };
}
/**
 * Default response format configuration
 *
 * Starts with a conservative approach: enable standards but maintain legacy compatibility
 * for a smooth migration path.
 */
export declare const DEFAULT_RESPONSE_CONFIG: ResponseFormatConfig;
/**
 * Environment-specific configuration overrides
 *
 * @param environment - Current environment (development, production, test)
 * @returns Environment-specific configuration
 */
export declare function getEnvironmentConfig(environment?: string): Partial<ResponseFormatConfig>;
/**
 * Update response format configuration at runtime
 *
 * @param newConfig - Partial configuration to merge with current settings
 */
export declare function updateResponseConfig(newConfig: Partial<ResponseFormatConfig>): void;
/**
 * Get current response format configuration
 *
 * @returns Current configuration
 */
export declare function getResponseConfig(): ResponseFormatConfig;
/**
 * Initialize configuration from environment variables
 *
 * @param environment - Environment name
 */
export declare function initializeResponseConfig(environment?: string): void;
/**
 * Check if a specific tool should use legacy format
 *
 * @param toolName - Name of the tool
 * @returns True if tool should use legacy format
 */
export declare function shouldUseLegacyFormat(toolName: string): boolean;
//# sourceMappingURL=response-config.d.ts.map