ACP v2 TypeScript SDK — EXPERIMENTAL DRAFT - v1.3.0
    Preparing search index...

    Type Alias ResourceLinkExperimental

    A resource that the server is capable of reading, included in a prompt or tool call result.

    type ResourceLink = {
        name: string;
        uri: string;
        title?: string | null;
        description?: string | null;
        icons?: Icon[] | null;
        mimeType?: MediaType | null;
        size?: number | null;
        annotations?: Annotations | null;
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    name uri title? description? icons? mimeType? size? annotations? _meta?
    name: string

    Human-readable name shown for this protocol object.

    uri: string

    URI associated with this resource or media payload.

    title?: string | null

    Optional display title for end-user UI.

    description?: string | null

    Optional human-readable details shown with this protocol object.

    icons?: Icon[] | null

    Optional set of sized icons that the client can display in a user interface.

    mimeType?: MediaType | null

    MIME type describing the encoded media payload.

    size?: number | null

    Optional size of the linked resource in bytes, if known.

    annotations?: Annotations | null

    Optional annotations that help clients decide how to display or route this content.

    Optional_meta

    _meta?: { [key: string]: unknown } | null

    The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

    See protocol docs: Extensibility

    Settings
    Member Visibility

    On This Page
    Properties