For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/genui/a2ui-prompt/interfaces/A2UIFunctionSpec.md.
Lynx
  • English
  • genui / a2ui-prompt / A2UIFunctionSpec

    A2UIFunctionSpec

    Prompt-facing schema for a client-side function the agent may call.

    Properties

    description?

    optional description: string;

    Defined in

    @lynx-js/genui/server/agent/a2ui-catalog.ts:53


    name

    name: string;

    Defined in

    @lynx-js/genui/server/agent/a2ui-catalog.ts:54


    parameters

    parameters: JsonSchema;

    Defined in

    @lynx-js/genui/server/agent/a2ui-catalog.ts:55


    returnType

    returnType: 
      | "string"
      | "number"
      | "boolean"
      | "object"
      | "array"
      | "any"
      | "void";

    Defined in

    @lynx-js/genui/server/agent/a2ui-catalog.ts:56

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.