mcp-use TypeScript API
    Preparing search index...

    Interface MCPClientConfigShape

    Top-level MCP client configuration.

    Callback and client identity values act as defaults for individual servers.

    interface MCPClientConfigShape {
        clientInfo?: ClientInfo;
        mcpServers?: Record<string, ServerConfig>;
        onElicitation?: OnElicitationCallback;
        onNotification?: OnNotificationCallback;
        onSampling?: OnSamplingCallback;
    }

    Hierarchy (View Summary)

    Index
    clientInfo? mcpServers? onElicitation? onNotification? onSampling?
    clientInfo?: ClientInfo

    Default client identity for all servers; overridable per server.

    mcpServers?: Record<string, ServerConfig>

    Server configurations keyed by the name used in client methods.

    onElicitation?: OnElicitationCallback

    Callback for elicitation requests from servers.

    onNotification?: OnNotificationCallback

    Callback for notifications from servers.

    onSampling?: OnSamplingCallback

    Callback for sampling input.

    Sampling is deprecated by the 2026 protocol. Retained for v1 push requests and the v2 input_required compatibility window.

    Settings
    Member Visibility

    On This Page
    Properties