@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface A2AAdapterOptions

    Options for createA2AAdapter.

    Auth posture. authenticate(req) runs BEFORE the tool handler sees the request. Return an AdcpAuthInfo to let the pipeline proceed with that principal; return null (or throw) to reject. A rejection currently surfaces as a generic JSON-RPC -32000 server error — the @a2a-js/sdk doesn't yet expose a typed authentication-failed code for the UserBuilder path. Production deployments SHOULD wire upstream middleware (e.g. express-jwt) to reject with a proper HTTP 401 / WWW-Authenticate challenge before the request reaches jsonRpcHandler. The authenticate option here is a last-line-of-defense guard, not the primary auth surface.

    Agent-card securitySchemes. Legacy 0.3 OpenAPI-style schemes are converted to the A2A 1.0 union and unsupported shapes fail at startup. Only put non-secret discovery data there (token endpoint, scopes, OIDC issuer URL). Never paste client secrets, private JWKS, or internal URLs into the card.

    Omitting authenticate makes the adapter anonymous — handlers see ctx.authInfo === undefined, matching serve({ authenticate: undefined }).

    interface A2AAdapterOptions {
        server: AdcpServer;
        authenticate?: (req: Request) => Promise<AdcpAuthInfo | null>;
        agentCard: A2AAgentCardOverrides;
        taskStore?: TaskStore;
        logger?: AdcpLogger;
        legacyCompat?: A2ALegacyCompatOptions;
    }
    Index
    server authenticate? agentCard taskStore? logger? legacyCompat?
    server: AdcpServer

    AdCP server whose registered tools this adapter exposes over A2A.

    authenticate?: (req: Request) => Promise<AdcpAuthInfo | null>

    Authenticate an inbound A2A request. Transport-level auth runs before AdcpServer.invoke() so the framework pipeline sees a verified authInfo. Return null (or throw) to reject.

    agentCard: A2AAgentCardOverrides

    Seller-supplied agent-card identity fields. Required.

    taskStore?: TaskStore

    A2A task store. Tests and development default to the SDK's in-memory store. Production must supply a bounded, durable implementation.

    logger?: AdcpLogger

    Optional logger. Falls back to console.

    legacyCompat?: A2ALegacyCompatOptions

    Controls the official A2A SDK's v0.3 compatibility handlers and agent-card interface. Defaults to { enabled: true } for backwards compatibility. Set enabled: false to expose only the native A2A 1.0 path.

    Settings
    Member Visibility

    On This Page
    Properties