purpose

Support

Set the function description shown to the AI when deciding which tool to call. description() is an alias for this method.

Parameters

stringRequired

Human-readable description of what this function does.

DataMap — Self for method chaining.

1 import { DataMap } from '@signalwire/sdk';
2 
3 const dm = new DataMap('get_weather');
4 dm.purpose('Look up current weather for a city');

Set the function description shown to the AI when deciding which tool to call. description() is an alias for this method.

stringRequired

Human-readable description of what this function does.

DataMap — Self for method chaining.

1 import { DataMap } from '@signalwire/sdk';
2 
3 const dm = new DataMap('get_weather');
4 dm.purpose('Look up current weather for a city');

1	import { DataMap } from '@signalwire/sdk';
2
3	const dm = new DataMap('get_weather');
4	dm.purpose('Look up current weather for a city');