For the complete documentation index, see llms.txt. This page is also available as Markdown.

Agent Copilot

Copilot chat UI add-on for AI agents with sidebar, tool execution, and Human In The Loop (HITL) support.

The Agent Copilot add-on (Umbraco.AI.Agent.Copilot) provides an interactive AI assistant sidebar in the Umbraco backoffice. It depends on Umbraco.AI.Agent.UI (shared chat components), which in turn depends on the Agent Runtime (Umbraco.AI.Agent).

Installation

Install the Copilot package — Umbraco.AI.Agent.UI and Umbraco.AI.Agent are pulled in transitively:

Package Manager Console
Install-Package Umbraco.AI.Agent.Copilot

Or via .NET CLI:

Terminal
dotnet add package Umbraco.AI.Agent.Copilot

Umbraco.AI.Agent.Copilot depends on Umbraco.AI.Agent.UI, which depends on Umbraco.AI.Agent. Installing Copilot installs all three packages.

Features

  • Sidebar Chat UI - Conversational interface in the backoffice

  • Content Awareness - Understands current editing context

  • Tool Execution - Frontend tools execute in the browser

  • HITL Approval - Human-in-the-loop confirmation for actions

  • AG-UI Integration - Real-time streaming responses

  • Entity Selector - Target specific content items

Quick Start

1. Install the Copilot Package

2. Create an Agent for the Copilot Surface

In the backoffice, navigate to the AI section > Agents and create an agent. To make it available in the Copilot sidebar, tick Copilot in the agent's Surfaces selection.

The Copilot surface is registered by CopilotAgentSurface with SurfaceId = "copilot". At runtime the sidebar loads only agents whose SurfaceIds contains "copilot". If more than one agent matches, the Copilot uses Auto mode (see Copilot Usage) to route each prompt to the most relevant agent.

3. Access the Copilot

The Copilot sidebar appears in sections that declare compatibility with it (Content and Media out of the box). Click the AI Assistant button in the backoffice header to toggle the sidebar.

Package Architecture

The Agent package provides:

  • Agent CRUD operations

  • AG-UI streaming endpoints (StreamAgentAGUIAsync)

  • Backend tool execution

  • Management API

The Agent UI package provides:

  • Shared chat element (<uai-chat>)

  • Frontend tool manager and executor

  • HITL approval infrastructure and the uaiAgentFrontendTool / uaiAgentToolRenderer manifest types

The Copilot package provides:

  • Sidebar host and backoffice header app

  • The copilot agent surface (CopilotAgentSurface)

  • Example frontend tools

Documentation

Section
Description

Copilot Usage

Using the chat interface

Frontend Tools

Creating browser-executable tools

Last updated

Was this helpful?