A11 TypeScript API - v0.7.0
    Preparing search index...

    Interface ActionPortSchemaOptions

    Declarative input/output port fields accepted by ActionPortSchema.

    interface ActionPortSchemaOptions {
        autofills?: readonly (NodeFragment | null)[];
        description?: string;
        jsonSchema?: string;
        name: string;
        required?: boolean;
        type: string;
        unary?: boolean;
    }
    Index
    autofills?: readonly (NodeFragment | null)[]

    Default input fragments; an autofilled input must otherwise be empty.

    description?: string

    Developer/model-facing explanation of what the port carries.

    jsonSchema?: string

    JSON Schema for the port's payload, as text. Empty when unknown.

    The describable half of a port's type. A TypeScript type does not survive to runtime, so unlike Python this side has nothing to derive one from -- but it carries and forwards whatever a peer sent, which is what lets a model be shown a remote tool's real argument types.

    name: string

    Port name used by handlers and on the wire.

    required?: boolean

    Whether callers must provide the port.

    type: string

    Application type or MIME-facing type description.

    unary?: boolean

    Whether the port represents one whole value rather than a stream.