Agent.getDescription()

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

Usage example

agent.getDescription()

Parameters

This method takes no parameters.

Returns

<PropertiesTable content={[ { name: 'description', type: 'string', description: 'The description of the agent, or an empty string if no description was configured.', }, ]} />

Related

• Agents overview