@convex-dev/agent 0.5.0-alpha.1 → 0.6.0-alpha.1

package/dist/client/createTool.d.ts

@@ -1,42 +1,123 @@
-import type { Schema, Tool, ToolCallOptions, ToolSet } from "ai";
-import { z } from "zod";
-import type { Agent } from "./index.js";
+import type { ToolResultOutput } from "@ai-sdk/provider-utils";
+import type { FlexibleSchema, ModelMessage, Tool, ToolExecutionOptions, ToolSet } from "ai";
 import type { GenericActionCtx, GenericDataModel } from "convex/server";
 import type { ProviderOptions } from "../validators.js";
+import type { Agent } from "./index.js";
 export type ToolCtx<DataModel extends GenericDataModel = GenericDataModel> = GenericActionCtx<DataModel> & {
-    agent: Agent;
+    agent?: Agent;
     userId?: string;
     threadId?: string;
     messageId?: string;
 };
+/**
+ * Function that is called to determine if the tool needs approval before it can be executed.
+ */
+export type ToolNeedsApprovalFunctionCtx<INPUT, Ctx extends ToolCtx = ToolCtx> = (ctx: Ctx, input: INPUT, options: {
+    /**
+     * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+     */
+    toolCallId: string;
+    /**
+     * Messages that were sent to the language model to initiate the response that contained the tool call.
+     * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
+     */
+    messages: ModelMessage[];
+    /**
+     * Additional context.
+     *
+     * Experimental (can break in patch releases).
+     */
+    experimental_context?: unknown;
+}) => boolean | PromiseLike<boolean>;
+export type ToolExecuteFunctionCtx<INPUT, OUTPUT, Ctx extends ToolCtx = ToolCtx> = (ctx: Ctx, input: INPUT, options: ToolExecutionOptions) => AsyncIterable<OUTPUT> | PromiseLike<OUTPUT>;
+type NeverOptional<N, T> = 0 extends 1 & N ? Partial<T> : [N] extends [never] ? Partial<Record<keyof T, undefined>> : T;
+/**
+ * Error message type for deprecated 'handler' property.
+ * Using a string literal type causes TypeScript to show this message in errors.
+ */
+type HANDLER_REMOVED_ERROR = "⚠️ 'handler' was removed in @convex-dev/agent v0.6.0. Rename to 'execute'. See: node_modules/@convex-dev/agent/MIGRATION.md";
+export type ToolOutputPropertiesCtx<INPUT, OUTPUT, Ctx extends ToolCtx = ToolCtx> = NeverOptional<OUTPUT, {
+    /**
+     * An async function that is called with the arguments from the tool call and produces a result.
+     * If `execute` is not provided, the tool will not be executed automatically.
+     *
+     * @param input - The input of the tool call.
+     * @param options.abortSignal - A signal that can be used to abort the tool call.
+     */
+    execute?: ToolExecuteFunctionCtx<INPUT, OUTPUT, Ctx>;
+    outputSchema?: FlexibleSchema<OUTPUT>;
+    /**
+     * @deprecated Removed in v0.6.0. Use `execute` instead.
+     */
+    handler?: HANDLER_REMOVED_ERROR;
+}>;
+/**
+ * Error message type for deprecated 'args' property.
+ * Using a string literal type causes TypeScript to show this message in errors.
+ */
+type ARGS_REMOVED_ERROR = "⚠️ 'args' was removed in @convex-dev/agent v0.6.0. Rename to 'inputSchema'. See: node_modules/@convex-dev/agent/MIGRATION.md";
+export type ToolInputProperties<INPUT> = {
+    /**
+     * The schema of the input that the tool expects.
+     * The language model will use this to generate the input.
+     * It is also used to validate the output of the language model.
+     *
+     * You can use descriptions on the schema properties to make the input understandable for the language model.
+     */
+    inputSchema: FlexibleSchema<INPUT>;
+    /**
+     * @deprecated Removed in v0.6.0. Use `inputSchema` instead.
+     */
+    args?: ARGS_REMOVED_ERROR;
+};
 /**
  * This is a wrapper around the ai.tool function that adds extra context to the
  * tool call, including the action context, userId, threadId, and messageId.
  * @param tool The tool. See https://sdk.vercel.ai/docs/ai-sdk-core/tools-and-tool-calling
- * but swap parameters for args and handler for execute.
+ * Currently contains deprecated parameters `args` and `handler` to maintain backwards compatibility
+ * but these will be removed in the future. Use `inputSchema` and `execute` instead, respectively.
+ *
  * @returns A tool to be used with the AI SDK.
  */
 export declare function createTool<INPUT, OUTPUT, Ctx extends ToolCtx = ToolCtx>(def: {
     /**
-    An optional description of what the tool does.
-    Will be used by the language model to decide whether to use the tool.
-    Not used for provider-defined tools.
-       */
+     * An optional description of what the tool does.
+     * Will be used by the language model to decide whether to use the tool.
+     * Not used for provider-defined tools.
+     */
     description?: string;
     /**
-    The schema of the input that the tool expects. The language model will use this to generate the input.
-    It is also used to validate the output of the language model.
-    Use descriptions to make the input understandable for the language model.
-       */
-    args: ToolParameters<INPUT>;
+     * An optional title of the tool.
+     */
+    title?: string;
+    /**
+     * Additional provider-specific metadata. They are passed through
+     * to the provider from the AI SDK and enable provider-specific
+     * functionality that can be fully encapsulated in the provider.
+     */
+    providerOptions?: ProviderOptions;
+} & ToolInputProperties<INPUT> & {
+    /**
+     * An optional list of input examples that show the language
+     * model what the input should look like.
+     */
+    inputExamples?: Array<{
+        input: NoInfer<INPUT>;
+    }>;
     /**
-    An async function that is called with the arguments from the tool call and produces a result.
-    If not provided, the tool will not be executed automatically.
-  
-    @args is the input of the tool call.
-    @options.abortSignal is a signal that can be used to abort the tool call.
-       */
-    handler: (ctx: Ctx, args: INPUT, options: ToolCallOptions) => PromiseLike<OUTPUT>;
+     * Whether the tool needs approval before it can be executed.
+     */
+    needsApproval?: boolean | ToolNeedsApprovalFunctionCtx<[
+        INPUT
+    ] extends [never] ? unknown : INPUT, Ctx>;
+    /**
+     * Strict mode setting for the tool.
+     *
+     * Providers that support strict mode will use this setting to determine
+     * how the input should be generated. Strict mode will always produce
+     * valid inputs, but it might limit what input schemas are supported.
+     */
+    strict?: boolean;
     /**
      * Provide the context to use, e.g. when defining the tool at runtime.
      */
@@ -45,24 +126,42 @@ export declare function createTool<INPUT, OUTPUT, Ctx extends ToolCtx = ToolCtx>
      * Optional function that is called when the argument streaming starts.
      * Only called when the tool is used in a streaming context.
      */
-    onInputStart?: (ctx: Ctx, options: ToolCallOptions) => void | PromiseLike<void>;
+    onInputStart?: (ctx: Ctx, options: ToolExecutionOptions) => void | PromiseLike<void>;
     /**
      * Optional function that is called when an argument streaming delta is available.
      * Only called when the tool is used in a streaming context.
      */
     onInputDelta?: (ctx: Ctx, options: {
         inputTextDelta: string;
-    } & ToolCallOptions) => void | PromiseLike<void>;
+    } & ToolExecutionOptions) => void | PromiseLike<void>;
     /**
      * Optional function that is called when a tool call can be started,
      * even if the execute function is not provided.
      */
     onInputAvailable?: (ctx: Ctx, options: {
-        input: [INPUT] extends [never] ? undefined : INPUT;
-    } & ToolCallOptions) => void | PromiseLike<void>;
-    providerOptions?: ProviderOptions;
+        input: [INPUT] extends [never] ? unknown : INPUT;
+    } & ToolExecutionOptions) => void | PromiseLike<void>;
+} & ToolOutputPropertiesCtx<INPUT, OUTPUT, Ctx> & {
+    /**
+     * Optional conversion function that maps the tool result to an output that can be used by the language model.
+     *
+     * If not provided, the tool result will be sent as a JSON object.
+     */
+    toModelOutput?: (ctx: Ctx, options: {
+        /**
+         * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+         */
+        toolCallId: string;
+        /**
+         * The input of the tool call.
+         */
+        input: [INPUT] extends [never] ? unknown : INPUT;
+        /**
+         * The output of the tool call.
+         */
+        output: 0 extends 1 & OUTPUT ? any : [OUTPUT] extends [never] ? any : NoInfer<OUTPUT>;
+    }) => ToolResultOutput | PromiseLike<ToolResultOutput>;
 }): Tool<INPUT, OUTPUT>;
 export declare function wrapTools(ctx: ToolCtx, ...toolSets: (ToolSet | undefined)[]): ToolSet;
-type ToolParameters<T> = z.Schema<T> | Schema<T>;
 export {};
 //# sourceMappingURL=createTool.d.ts.map

package/dist/client/createTool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAEjE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,MAAM,OAAO,CAAC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,IACvE,gBAAgB,CAAC,SAAS,CAAC,GAAG;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEJ;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,OAAO,GAAG,OAAO,EAAE,GAAG,EAAE;IAC5E;;;;SAIK;IACL,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;SAIK;IACL,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC5B;;;;;;SAMK;IACL,OAAO,EAAE,CACP,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,eAAe,KACrB,WAAW,CAAC,MAAM,CAAC,CAAC;IACzB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,KACrB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,eAAe,KAChB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CACjB,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP,KAAK,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;KACpD,GAAG,eAAe,KAChB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAG9B,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CA6BtB;AAOD,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,GAAG,QAAQ,EAAE,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GACnC,OAAO,CAiBT;AAGD,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,IAAI,EACJ,oBAAoB,EACpB,OAAO,EACR,MAAM,IAAI,CAAC;AAEZ,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAWxC,MAAM,MAAM,OAAO,CAAC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,IACvE,gBAAgB,CAAC,SAAS,CAAC,GAAG;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,4BAA4B,CACtC,KAAK,EACL,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,CACF,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE;IACP;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC,KACE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;AAEpC,MAAM,MAAM,sBAAsB,CAChC,KAAK,EACL,MAAM,EACN,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,CACF,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,oBAAoB,KAC1B,aAAa,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;AAEjD,KAAK,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GACtC,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,GACnC,CAAC,CAAC;AAER;;;GAGG;AACH,KAAK,qBAAqB,GACxB,6HAA6H,CAAC;AAEhI,MAAM,MAAM,uBAAuB,CACjC,KAAK,EACL,MAAM,EACN,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,aAAa,CACf,MAAM,EACN;IACE;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IACrD,YAAY,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,CACF,CAAC;AAEF;;;GAGG;AACH,KAAK,kBAAkB,GACrB,8HAA8H,CAAC;AAEjI,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI;IACvC;;;;;;OAMG;IACH,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,OAAO,GAAG,OAAO,EACrE,GAAG,EAAE;IACH;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;KACvB,CAAC,CAAC;IACH;;OAEG;IACH,aAAa,CAAC,EACV,OAAO,GACP,4BAA4B,CAC1B;QAAC,KAAK;KAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,KAAK,EACzC,GAAG,CACJ,CAAC;IACN;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,oBAAoB,KAC1B,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QAAE,cAAc,EAAE,MAAM,CAAA;KAAE,GAAG,oBAAoB,KACvD,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CACjB,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP,KAAK,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;KAClD,GAAG,oBAAoB,KACrB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;CAC/B,GAAG,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG;IAChD;;;;OAIG;IACH,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,KAAK,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;QACjD;;WAEG;QACH,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,MAAM,GACxB,GAAG,GACH,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GACtB,GAAG,GACH,OAAO,CAAC,MAAM,CAAC,CAAC;KACvB,KACE,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;CACvD,GACF,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CA+FrB;AAMD,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,GAAG,QAAQ,EAAE,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GACnC,OAAO,CAgBT"}

package/dist/client/createTool.js

@@ -1,41 +1,97 @@
 import { tool } from "ai";
-import { z } from "zod";
+const MIGRATION_URL = "node_modules/@convex-dev/agent/MIGRATION.md";
+const warnedDeprecations = new Set();
+function warnDeprecation(key, message) {
+    if (!warnedDeprecations.has(key)) {
+        warnedDeprecations.add(key);
+        console.warn(`[@convex-dev/agent] ${message}\n  See: ${MIGRATION_URL}`);
+    }
+}
 /**
  * This is a wrapper around the ai.tool function that adds extra context to the
  * tool call, including the action context, userId, threadId, and messageId.
  * @param tool The tool. See https://sdk.vercel.ai/docs/ai-sdk-core/tools-and-tool-calling
- * but swap parameters for args and handler for execute.
+ * Currently contains deprecated parameters `args` and `handler` to maintain backwards compatibility
+ * but these will be removed in the future. Use `inputSchema` and `execute` instead, respectively.
+ *
  * @returns A tool to be used with the AI SDK.
  */
 export function createTool(def) {
+    // Runtime backwards compat - types will show errors but runtime still works
+    const inputSchema = def.inputSchema ?? def.args;
+    if (!inputSchema)
+        throw new Error("To use a Convex tool, you must provide an `inputSchema`");
+    if (def.args && !def.inputSchema) {
+        warnDeprecation("createTool.args", "createTool: 'args' is deprecated. Use 'inputSchema' instead.");
+    }
+    if (def.handler && !def.execute) {
+        warnDeprecation("createTool.handler", "createTool: 'handler' is deprecated. Use 'execute' instead.");
+    }
+    const executeHandler = def.execute ?? def.handler;
+    if (!executeHandler && !def.outputSchema)
+        throw new Error("To use a Convex tool, you must either provide an execute" +
+            " handler function, define an outputSchema, or both");
     const t = tool({
         type: "function",
         __acceptsCtx: true,
         ctx: def.ctx,
         description: def.description,
-        inputSchema: def.args,
-        async execute(args, options) {
+        title: def.title,
+        providerOptions: def.providerOptions,
+        inputSchema,
+        inputExamples: def.inputExamples,
+        needsApproval(input, options) {
+            const needsApproval = def.needsApproval;
+            if (!needsApproval || typeof needsApproval === "boolean")
+                return Boolean(needsApproval);
             if (!getCtx(this)) {
                 throw new Error("To use a Convex tool, you must either provide the ctx" +
                     " at definition time (dynamically in an action), or use the Agent to" +
                     " call it (which injects the ctx, userId and threadId)");
             }
-            return def.handler(getCtx(this), args, options);
+            return needsApproval(getCtx(this), input, options);
         },
-        providerOptions: def.providerOptions,
+        strict: def.strict,
+        ...(executeHandler
+            ? {
+                execute(input, options) {
+                    if (!getCtx(this)) {
+                        throw new Error("To use a Convex tool, you must either provide the ctx" +
+                            " at definition time (dynamically in an action), or use the Agent to" +
+                            " call it (which injects the ctx, userId and threadId)");
+                    }
+                    return executeHandler(getCtx(this), input, options);
+                },
+            }
+            : {}),
+        outputSchema: def.outputSchema,
     });
     if (def.onInputStart) {
-        t.onInputStart = def.onInputStart.bind(t, getCtx(t));
+        const origOnInputStart = def.onInputStart;
+        t.onInputStart = function (options) {
+            return origOnInputStart.call(this, getCtx(this), options);
+        };
     }
     if (def.onInputDelta) {
-        t.onInputDelta = def.onInputDelta.bind(t, getCtx(t));
+        const origOnInputDelta = def.onInputDelta;
+        t.onInputDelta = function (options) {
+            return origOnInputDelta.call(this, getCtx(this), options);
+        };
     }
     if (def.onInputAvailable) {
-        t.onInputAvailable = def.onInputAvailable.bind(t, getCtx(t));
+        const origOnInputAvailable = def.onInputAvailable;
+        t.onInputAvailable = function (options) {
+            return origOnInputAvailable.call(this, getCtx(this), options);
+        };
+    }
+    if (def.toModelOutput) {
+        const origToModelOutput = def.toModelOutput;
+        t.toModelOutput = function (options) {
+            return origToModelOutput.call(this, getCtx(this), options);
+        };
     }
     return t;
 }
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function getCtx(tool) {
     return tool.ctx;
 }
@@ -46,8 +102,7 @@ export function wrapTools(ctx, ...toolSets) {
             continue;
         }
         for (const [name, tool] of Object.entries(toolSet)) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            if (!tool.__acceptsCtx) {
+            if (tool && !tool.__acceptsCtx) {
                 output[name] = tool;
             }
             else {

package/dist/client/createTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"createTool.js","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAA+C,GA4DxE;IACC,MAAM,CAAC,GAAG,IAAI,CAAC;QACb,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,WAAW,EAAE,GAAG,CAAC,IAAI;QACrB,KAAK,CAAC,OAAO,CAAC,IAAW,EAAE,OAAwB;YACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;oBACrD,qEAAqE;oBACrE,uDAAuD,CAC1D,CAAC;YACJ,CAAC;YACD,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QACD,eAAe,EAAE,GAAG,CAAC,eAAe;KACrC,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzB,CAAC,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,8DAA8D;AAC9D,SAAS,MAAM,CAAsB,IAAS;IAC5C,OAAQ,IAAqB,CAAC,GAAG,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,GAAY,EACZ,GAAG,QAAiC;IAEpC,MAAM,MAAM,GAAG,EAAa,CAAC;IAC7B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,8DAA8D;YAC9D,IAAI,CAAE,IAAY,CAAC,YAAY,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"createTool.js","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAK1B,MAAM,aAAa,GAAG,6CAA6C,CAAC;AACpE,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;AAC7C,SAAS,eAAe,CAAC,GAAW,EAAE,OAAe;IACnD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,CAAC,IAAI,CAAC,uBAAuB,OAAO,YAAY,aAAa,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AA0GD;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CACxB,GAmGG;IAEH,4EAA4E;IAC5E,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAK,GAAW,CAAC,IAAI,CAAC;IACzD,IAAI,CAAC,WAAW;QACd,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAE7E,IAAK,GAAW,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;QAC1C,eAAe,CACb,iBAAiB,EACjB,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,IAAK,GAAW,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACzC,eAAe,CACb,oBAAoB,EACpB,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,IAAK,GAAW,CAAC,OAAO,CAAC;IAC3D,IAAI,CAAC,cAAc,IAAI,CAAC,GAAG,CAAC,YAAY;QACtC,MAAM,IAAI,KAAK,CACb,0DAA0D;YACxD,oDAAoD,CACvD,CAAC;IAEJ,MAAM,CAAC,GAAG,IAAI,CAAgB;QAC5B,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,eAAe,EAAE,GAAG,CAAC,eAAe;QACpC,WAAW;QACX,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,aAAa,CAA4B,KAAK,EAAE,OAAO;YACrD,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;YACxC,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,SAAS;gBACtD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC;YAEhC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;oBACrD,qEAAqE;oBACrE,uDAAuD,CAC1D,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,GAAG,CAAC,cAAc;YAChB,CAAC,CAAC;gBACE,OAAO,CAEL,KAAY,EACZ,OAA6B;oBAE7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;4BACrD,qEAAqE;4BACrE,uDAAuD,CAC1D,CAAC;oBACJ,CAAC;oBACD,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;gBACtD,CAAC;aACF;YACH,CAAC,CAAC,EAAE,CAAC;QACP,YAAY,EAAE,GAAG,CAAC,YAAY;KAC/B,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC;QAC1C,CAAC,CAAC,YAAY,GAAG,UAAqC,OAAO;YAC3D,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC;QAC1C,CAAC,CAAC,YAAY,GAAG,UAAqC,OAAO;YAC3D,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzB,MAAM,oBAAoB,GAAG,GAAG,CAAC,gBAAgB,CAAC;QAClD,CAAC,CAAC,gBAAgB,GAAG,UAAqC,OAAO;YAC/D,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;QACtB,MAAM,iBAAiB,GAAG,GAAG,CAAC,aAAa,CAAC;QAC5C,CAAC,CAAC,aAAa,GAAG,UAAqC,OAAO;YAC5D,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,MAAM,CAAsB,IAAS;IAC5C,OAAQ,IAAqB,CAAC,GAAG,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,GAAY,EACZ,GAAG,QAAiC;IAEpC,MAAM,MAAM,GAAG,EAAa,CAAC;IAC7B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,IAAI,IAAI,IAAI,CAAE,IAAY,CAAC,YAAY,EAAE,CAAC;gBACxC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/client/defaultComponent.d.ts

@@ -0,0 +1,11 @@
+import type { AgentComponent } from "./types.js";
+export type CustomComponent = {
+    /**
+     * If you have a custom name for the agent component, you can pass it here
+     * as components.myAgentName.
+     */
+    component?: AgentComponent;
+};
+export declare function componentAPI(args?: CustomComponent): AgentComponent;
+export declare const defaultComponent: AgentComponent;
+//# sourceMappingURL=defaultComponent.d.ts.map

package/dist/client/defaultComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultComponent.d.ts","sourceRoot":"","sources":["../../src/client/defaultComponent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B,CAAC;AAEF,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,eAAe,GAAG,cAAc,CAEnE;AAED,eAAO,MAAM,gBAAgB,EACN,cAAc,CAAC"}

package/dist/client/defaultComponent.js

@@ -0,0 +1,7 @@
+import { componentsGeneric } from "convex/server";
+export function componentAPI(args) {
+    return args?.component ?? defaultComponent;
+}
+export const defaultComponent = componentsGeneric()
+    .agent;
+//# sourceMappingURL=defaultComponent.js.map

package/dist/client/defaultComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultComponent.js","sourceRoot":"","sources":["../../src/client/defaultComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAWlD,MAAM,UAAU,YAAY,CAAC,IAAsB;IACjD,OAAO,IAAI,EAAE,SAAS,IAAI,gBAAgB,CAAC;AAC7C,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,EAAE;KAChD,KAAkC,CAAC"}