diff --git a/.changeset/nervous-deers-boil.md b/.changeset/nervous-deers-boil.md new file mode 100644 index 000000000000..8e7f4fc51078 --- /dev/null +++ b/.changeset/nervous-deers-boil.md @@ -0,0 +1,5 @@ +--- +'ai': patch +--- + +feat(agent): add optional description property to agent diff --git a/packages/ai/src/agent/agent.ts b/packages/ai/src/agent/agent.ts index 381ca49b0f37..68d59cbef528 100644 --- a/packages/ai/src/agent/agent.ts +++ b/packages/ai/src/agent/agent.ts @@ -28,6 +28,11 @@ export type AgentSettings< */ name?: string; + /** + * The description of what the agent does. + */ + description?: string; + /** * The system prompt to use. */ @@ -146,6 +151,13 @@ export class Agent< return this.settings.name; } + /** + * The description of what the agent does. + */ + get description(): string | undefined { + return this.settings.description; + } + /** * The tools that the agent can use. */