Skip to main content
Mastra v1 is coming in January 2026. Get ahead by starting new projects with the beta or upgrade your existing project today.

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 exampleDirect link to Usage example

agent.getDescription();

ParametersDirect link to Parameters

This method takes no parameters.

ReturnsDirect link to Returns

description:

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

On this page