parameter

Add a function parameter to the tool definition.

Parameters

name

stringRequired

Parameter name.

paramType

stringRequired

JSON schema type for the parameter.

"string" — text value
"integer" — whole number value
"number" — numeric value including decimals
"boolean" — true or false value
"array" — list of values
"object" — nested key-value structure

description

stringRequired

Description of the parameter shown to the AI.

opts

object

Optional configuration.

opts.required

boolean

Whether this parameter is required.

opts.enum

string[]

Optional list of allowed values for this parameter.

Returns

DataMap — Self for method chaining.

Example

1 import { DataMap } from '@signalwire/sdk';
2 
3 const weather = new DataMap('get_weather');
4 weather
5   .purpose('Get current weather for a city')
6   .parameter('city', 'string', 'City name', { required: true })
7   .parameter('units', 'string', 'Temperature units', { enum: ['fahrenheit', 'celsius'] });
8 
9 console.log(weather.toSwaigFunction());

1	import { DataMap } from '@signalwire/sdk';
2
3	const weather = new DataMap('get_weather');
4	weather
5	.purpose('Get current weather for a city')
6	.parameter('city', 'string', 'City name', { required: true })
7	.parameter('units', 'string', 'Temperature units', { enum: ['fahrenheit', 'celsius'] });
8
9	console.log(weather.toSwaigFunction());