purpose

View as MarkdownOpen in Claude

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

Parameters

description
stringRequired

Human-readable description of what this function does.

Returns

DataMap — Self for method chaining.

Example

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