@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface CallToolOptions

    Options for ProtocolClient.callTool. All fields are optional.

    webhookUrl / webhookSecret / webhookToken are for ASYNC TASK STATUS notifications (push_notification_config). For reporting webhooks (reporting_webhook), include them directly in args — they stay in skill parameters and are sent verbatim to the agent.

    interface CallToolOptions {
        debugLogs?: DebugLogEntry[];
        webhookUrl?: string;
        webhookSecret?: string;
        webhookToken?: string;
        serverVersion?: "v2" | "v3";
        session?: { contextId?: string; taskId?: string };
        adcpVersion?: string;
        wireAdcpVersion?: string;
        versionEnvelope?: VersionEnvelopeMode;
        transport?: TransportOptions;
        signal?: AbortSignal;
        onTransportActivity?: TransportActivityHandler;
        transportActivityContext?: {
            operationId?: string;
            taskId?: string;
            contextId?: string;
            idempotencyKey?: string;
        };
    }
    Index

    Properties

    debugLogs? webhookUrl? webhookSecret? webhookToken? serverVersion? session? adcpVersion? wireAdcpVersion? versionEnvelope? transport? signal? onTransportActivity? transportActivityContext?

    Properties

    debugLogs?: DebugLogEntry[]

    Debug log array. Mutated in place by the protocol layer.

    webhookUrl?: string

    URL for async task status notifications.

    webhookSecret?: string

    HMAC-SHA256 secret for push_notification_config authentication.

    webhookToken?: string

    Bearer token for push_notification_config validation.

    serverVersion?: "v2" | "v3"

    Pinned protocol generation when the agent advertises both v2 and v3.

    session?: { contextId?: string; taskId?: string }

    A2A session continuity (contextId carries conversation, taskId resumes a task).

    adcpVersion?: string

    AdCP version pin from the calling client/server instance. Sets the wire-level adcp_major_version field per-call instead of from the SDK-pinned ADCP_MAJOR_VERSION constant. Default falls back to the constant so call sites that don't plumb a per-instance version keep their existing behavior. An explicit adcp_major_version / adcp_version in args overrides this — conformance harnesses use that path to probe seller version negotiation.

    wireAdcpVersion?: string

    Optional wire-only version override. Schema selection and client construction can remain pinned to adcpVersion; the request envelope is emitted for this release-precision line.

    versionEnvelope?: VersionEnvelopeMode

    Controls whether the SDK injects AdCP version envelope fields into the outgoing request. Defaults to auto. 3.0 pins emit only the legacy adcp_major_version; 3.1+ pins emit both the legacy major and exact adcp_version marker. major-only forces the legacy integer marker without the 3.1 string marker for strict pre-3.1 peers discovered at runtime.

    transport?: TransportOptions

    Transport-level safeguards (size caps, etc.). Per-call override of any matching field on the client constructor's transport option.

    signal?: AbortSignal

    Caller-owned cancellation signal for the in-flight protocol call.

    onTransportActivity?: TransportActivityHandler

    Transport-level diagnostics callback for outbound HTTP requests.

    transportActivityContext?: {
        operationId?: string;
        taskId?: string;
        contextId?: string;
        idempotencyKey?: string;
    }

    Correlation metadata attached to transport diagnostics events emitted while this protocol call is active.

    Settings

    Member Visibility

    On This Page

    Properties