perplexity-mcp-server/dist/utils/internal/requestContext.d.ts

A Perplexity API Model Context Protocol (MCP) server that unlocks Perplexity's search-augmented AI capabilities for LLM agents. Features robust error handling, secure input validation, and transparent reasoning with the showThinking parameter. Built with

/**
 * @fileoverview Utilities for creating and managing request contexts.
 * A request context is an object carrying a unique ID, timestamp, and other
 * relevant data for logging, tracing, and processing. It also defines
 * configuration and operational context structures.
 * @module src/utils/internal/requestContext
 */
/**
 * Defines the core structure for context information associated with a request or operation.
 * This is fundamental for logging, tracing, and passing operational data.
 */
export interface RequestContext {
    /**
     * Unique ID for the context instance.
     * Used for log correlation and request tracing.
     */
    requestId: string;
    /**
     * ISO 8601 timestamp indicating when the context was created.
     */
    timestamp: string;
    /**
     * Allows arbitrary key-value pairs for specific context needs.
     * Using `unknown` promotes type-safe access.
     * Consumers must type-check/assert when accessing extended properties.
     */
    [key: string]: unknown;
}
/**
 * Configuration for the {@link requestContextService}.
 * Allows for future extensibility of service-wide settings.
 */
export interface ContextConfig {
    /** Custom configuration properties. Allows for arbitrary key-value pairs. */
    [key: string]: unknown;
}
/**
 * Represents a broader context for a specific operation or task.
 * It can optionally include a base {@link RequestContext} and other custom properties
 * relevant to the operation.
 */
export interface OperationContext {
    /** Optional base request context data, adhering to the `RequestContext` structure. */
    requestContext?: RequestContext;
    /** Allows for additional, custom properties specific to the operation. */
    [key: string]: unknown;
}
/**
 * Primary export for request context functionalities.
 * This service provides methods to create and manage {@link RequestContext} instances,
 * which are essential for logging, tracing, and correlating operations.
 */
export declare const requestContextService: {
    /**
     * Internal configuration store for the service.
     */
    config: ContextConfig;
    /**
     * Configures the request context service with new settings.
     * Merges the provided partial configuration with existing settings.
     *
     * @param config - A partial `ContextConfig` object containing settings to update or add.
     * @returns A shallow copy of the newly updated configuration.
     */
    configure(config: Partial<ContextConfig>): ContextConfig;
    /**
     * Retrieves a shallow copy of the current service configuration.
     * This prevents direct mutation of the internal configuration state.
     *
     * @returns A shallow copy of the current `ContextConfig`.
     */
    getConfig(): ContextConfig;
    /**
     * Creates a new {@link RequestContext} instance.
     * Each context is assigned a unique `requestId` (UUID) and a current `timestamp` (ISO 8601).
     * Additional custom properties can be merged into the context.
     *
     * @param additionalContext - An optional record of key-value pairs to be
     *   included in the created request context.
     * @returns A new `RequestContext` object.
     */
    createRequestContext(additionalContext?: Record<string, unknown>): RequestContext;
};