CreateGadgetConfig
Defined in: gadgets/create-gadget.ts:36
Configuration for creating a function-based gadget.
Type Parameters
Section titled “Type Parameters”TSchema
Section titled “TSchema”TSchema extends ZodType
Properties
Section titled “Properties”description
Section titled “description”description:
string
Defined in: gadgets/create-gadget.ts:41
Human-readable description of what the gadget does
examples?
Section titled “examples?”
optionalexamples:GadgetExample<InferSchema<TSchema>>[]
Defined in: gadgets/create-gadget.ts:60
Optional usage examples to help LLMs understand proper invocation
execute()
Section titled “execute()”execute: (
params,ctx?) =>GadgetExecuteReturn|Promise<GadgetExecuteReturn>
Defined in: gadgets/create-gadget.ts:51
Execution function with typed parameters. Can return string or { result, cost? }. Optionally receives ExecutionContext for callback-based cost reporting.
Parameters
Section titled “Parameters”params
Section titled “params”InferSchema<TSchema>
Returns
Section titled “Returns”GadgetExecuteReturn | Promise<GadgetExecuteReturn>
optionalname:string
Defined in: gadgets/create-gadget.ts:38
Optional custom name (defaults to “FunctionGadget”)
schema
Section titled “schema”schema:
TSchema
Defined in: gadgets/create-gadget.ts:44
Zod schema for parameter validation
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs:number
Defined in: gadgets/create-gadget.ts:57
Optional timeout in milliseconds