Contextual Copilot
Contextual Copilot chat UI add-on for AI agents with sidebar, tool execution, and Human In The Loop (HITL) support.
The Contextual Copilot add-on (Umbraco.AI.Agent.Copilot) provides an interactive AI assistant sidebar in the Umbraco backoffice, scoped to the content or media item currently being edited. It depends on Umbraco.AI.Agent.UI (shared chat components), which in turn depends on the Agent Runtime (Umbraco.AI.Agent).
Installation
Install the Contextual Copilot package — Umbraco.AI.Agent.UI and Umbraco.AI.Agent are pulled in transitively:
Install-Package Umbraco.AI.Agent.CopilotOr via .NET CLI:
dotnet add package Umbraco.AI.Agent.CopilotFeatures
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
Step 1: Install the Contextual Copilot Package
Step 2: Create an Agent for the Contextual Copilot Surface
In the backoffice, navigate to the AI section > Agents and create an agent. To make it available in the Contextual Copilot sidebar, tick Copilot in the agent's Surfaces selection. This is the option registered by the Contextual Copilot add-on, as distinct from the Copilot Workspace option next to it.
The Contextual 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, Contextual Copilot uses Auto mode (see Usage) to route each prompt to the most relevant agent.
Step 3: Access Contextual Copilot
The Contextual Copilot sidebar appears in sections that declare compatibility with it (Content and Media out of the box). Open a content or media item and click the floating AI Assistant button in the bottom-right corner of the workspace 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/uaiAgentToolRenderermanifest types
The Contextual Copilot package provides:
Sidebar host and the floating trigger button shown in supported workspaces
The
copilotagent surface (CopilotAgentSurface)Example frontend tools
Documentation
Using the chat interface
Creating browser-executable tools
Related
Copilot Workspace - Broader, cross-site AI conversations with persisted history and projects
Agent Runtime - Backend agent functionality
Add-ons Overview - All add-on packages
AI Contexts - Brand voice and guidelines
Last updated
Was this helpful?