description

View as MarkdownOpen in Claude

Alias for purpose. Sets the human-readable description of the tool shown to the AI.

Parameters

description
stringRequired

A human-readable description of the tool.

Returns

DataMap — Self for method chaining.

Example

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