Skip to content

AgentDescriptor

← All HTTP schemas

A summary view of an agent listed in the catalog. It carries everything the user interface needs to draw the agent list, without having to build the agent.

Shape: object

Property Required Type Description Rules
name yes string Gets the unique name of the agent.
displayName no string Gets the name shown in the user interface.
description no string Gets the short description.
origin yes AgentDefinitionOrigin Gets the origin of the definition.
sourceName yes string Gets the name of the source that supplies this agent, for example code or database. Several sources can share the same AgentDefinitionOrigin AgentDescriptor.Origin value.
version no integer (int32) Gets the definition version. It is always 1 for code agents. pattern `^-?(?:0\
model no null oneOf ModelBinding
toolNames no array of string Gets the names of the tools this agent may use.
skillNames no array of string Gets the names of the skills this agent may load at run time.
callableAgentNames no array of string Gets the names of the other agents this agent may call.
usesHarness no boolean Gets whether the harness capabilities are enabled.
updatedAt no string (date-time) Gets the time of the last change (UTC).