Skip to content

AgentChat should have a Description property; display-name and description should be populated from the backing entity #823

Description

@JoshuaRowePhantom

\AgentChat\ currently exposes a \DisplayName\ property (line 352, \AgentChat.cs) set from \DisplayNameOverride ?? clientInfo.DisplayName\ at initialisation. It has no \Description\ property.

Two changes are needed:

1 — Add \Description\ to \AgentChat\

Add a \string Description { get; private set; }\ property to \AgentChat, parallel to \DisplayName. Populate it from a new \DescriptionOverride\ field on \InternalCreateAgentChatRequest.

2 — Populate display-name and description from the backing entity

When an \AgentChat\ is backed by a workspace entity (i.e. loaded from or associated with persistence), its \DisplayName\ and \Description\ should reflect the entity's \display-name.default\ and \description\ fields respectively. This ensures that:

  • Human-readable names set in the entity (via the entity editor or by the scan/discovery tools) appear in the chat UI without manual overrides.
  • Renaming the entity in the workspace UI propagates to the chat's displayed name.

The entity-reading path (wherever \AgentChat\ is created or restored from an entity snapshot) should extract \display-name.default\ and \description\ from the entity data and pass them as \DisplayNameOverride\ / \DescriptionOverride.

Affected Files

File Change
\Phantom.Workspaces.Llm.Core/AgentChat.cs\ Add \Description\ property; populate from \DescriptionOverride\
\Phantom.Workspaces.Llm.Core/InternalCreateAgentChatRequest.cs\ (or equivalent) Add \DescriptionOverride\
Entity-reading path that creates \AgentChat\ from an entity Read \display-name.default\ and \description; pass as overrides

Expected Tests

Test Name Class What It Verifies
\AgentChat_Description_DefaultsToEmpty\ \AgentChatTests\ \AgentChat.Description\ is empty string when no override is set
\AgentChat_Description_UsesDescriptionOverride\ \AgentChatTests\ \AgentChat.Description\ returns \DescriptionOverride\ when set
\AgentChatFromEntity_DisplayName_ReadsFromEntityDisplayName\ \AgentChatEntityTests\ When created from an entity with \display-name.default, \AgentChat.DisplayName\ matches
\AgentChatFromEntity_Description_ReadsFromEntityDescription\ \AgentChatEntityTests\ When created from an entity with \description, \AgentChat.Description\ matches

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingfailed-verificationBug failed automated verificationverified-locallyImplementation has been verified locally

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions