registerSwaigFunction

Register a pre-built SwaigFunction instance or a raw function descriptor (e.g., from a DataMap). Unlike defineTool(), this method accepts pre-built objects rather than taking a handler callback.

Parameters

fn

SwaigFunction | Record<string, unknown>Required

A SwaigFunction instance or a plain object with a "function" key. Typically generated by DataMap.toSwaigFunction().

Returns

AgentBase — Returns this for method chaining.

Example

1 import { AgentBase, DataMap, FunctionResult } from '@signalwire/sdk';
2 
3 const agent = new AgentBase({ name: 'plant-agent', route: '/plants' });
4 agent.setPromptText('You are a helpful plant care assistant.');
5 
6 // Create a DataMap that calls a plant API server-side
7 const plantTool = new DataMap('get_plant_info')
8   .description('Get care information for a plant')
9   .parameter('plantId', 'string', 'Plant ID', { required: true })
10   .webhook('GET', 'https://api.plants.example.com/plants/${args.plantId}')
11   .output(new FunctionResult(
12     'The plant ${args.plantId} needs ${response.water_schedule} watering.',
13   ));
14 
15 // Register the DataMap as a SWAIG function
16 agent.registerSwaigFunction(plantTool.toSwaigFunction());
17 await agent.serve();