@assemblyline-agents/openui

Official OpenUI artifact plugin. It contributes a reviewed operating Skill and three tools: openui_create, openui_update, and openui_publish.

Add the plugin

assembly-line add openui agent

The command selects openui in agent.md and updates plugins.lock. It does not create root tool wrappers or a tool-config/ directory.

Publishing requires R2_PUBLIC_BASE_URL or S3_PUBLIC_BASE_URL to be an HTTPS origin. The official plugin always exposes the complete standard OpenUI component library. Configure its brand and theme declaratively in agent.md:

capabilities:
  openui:
    config:
      brand:
        name: Example
        legalName: Example, Inc.
        theme:
          background: "#F7F7F5"
          foreground: "#FFFFFF"
          textBrand: "#1F2937"
          textAccentPrimary: "#2563EB"
          borderDefault: "#E5E7EB"
          borderAccent: "#2563EB"
          fontHeading: '"Cormorant Garamond", Georgia, serif'
          fontBody: '"Outfit", Arial, sans-serif'
        footer: Example | Confidential

brand accepts name, legalName, OpenUI theme tokens, an optional data-URI logo, and footer. The package owns the component library and trusted renderer; agent configuration cannot provide executable rendering code. Shell headings, report headings, body copy, and chart palettes all inherit from these theme tokens, so one declarative brand profile applies to the complete artifact rather than only the inner component tree.

Change only supported authority exceptions. For example, keep creation and editing but remove publication:

capabilities:
  openui:
    tools:
      disable: [openui_publish]

To change the component pack or trusted renderer, publish a reviewed plugin implementation that uses this package's TypeScript APIs. Those changes are executable plugin policy, not agent configuration.

Lifecycle and security

Artifacts use immutable revisions. Publication renders the selected revision, verifies the stored bytes, and gives the channel the exact HTTPS URL. The model never supplies HTML, CSS, JavaScript, or the final delivery URL.

New publications use reports/<opaque-token>/index.html under the blob store's public base URL and prefix. Draft revision keys remain private. The standard renderer includes Open Graph and Twitter summary metadata in the initial HTML: the exact report title, the configured brand's Reports name, and a short brand description. It does not expose report body content in preview metadata or generate a thumbnail. Photon promotes the selected canonical URL to a native link preview. See report delivery.

openui_create.document and openui_update.document accept either inline OpenUI Lang or an exact @/workspace/<file> reference. Workspace references are resolved through the current run's sandbox, remain confined below /workspace, and are subject to the same document-size and parser policy as inline input. Exact @/workspace/<file>.md references are deterministically wrapped in the standard Stack and Markdown-rendering TextContent, so a faithful Markdown publication does not require the model to reproduce the source. This keeps large generated reports out of tool-call payloads.

The official renderer runs with a network-disabled content security policy. Published links are unlisted bearer links; use channel file delivery when an artifact must remain private.

License

MIT