Skip to main content
Mastra 1.0 is available 🎉 Read announcement

Agent.getDescription()

The .getDescription() method retrieves the description configured for an agent. This method returns a simple string description that describes the agent's purpose and capabilities.

Usage example
Direct link to Usage example

agent.getDescription();

Parameters
Direct link to Parameters

This method takes no parameters.

Returns
Direct link to Returns

description:

string
The description of the agent, or an empty string if no description was configured.
On this page