Function defineTool

defineTool<TArgs extends JsonObject>(
tool: CanonicalTool<TArgs>,
): CanonicalTool<TArgs>

Declares a tool while preserving TypeScript inference for its argument shape.

Type Parameters

TArgs extends JsonObject

Parameters

tool: CanonicalTool<TArgs>

Returns CanonicalTool<TArgs>

Example

const weather = defineTool({
  name: 'lookup_weather',
  description: 'Look up weather by city',
  parameters: {
    type: 'object',
    properties: {
      city: { type: 'string' },
    },
    required: ['city'],
  },
  async execute(args) {
    return { city: args.city, forecast: 'Sunny' };
  },
});