sdk: modify custom tool slightly to match with ai-sdk

Author: charleslien

sdk/src/client.ts

@@ -17,7 +17,7 @@ import {
 import { MAX_AGENT_STEPS_DEFAULT } from '../../common/src/constants/agents'
 import { API_KEY_ENV_VAR } from '../../common/src/old-constants'
 import { toolNames } from '../../common/src/tools/constants'
-import type { PublishedClientToolName } from '../../common/src/tools/list'
+
 import {
   clientToolCallSchema,
   type ClientToolCall,
@@ -31,6 +31,7 @@ import type {
   PublishedToolName,
   ToolName,
 } from '../../common/src/tools/constants'
+import type { PublishedClientToolName } from '../../common/src/tools/list'
 import type {
   ToolResultOutput,
   ToolResultPart,
@@ -218,7 +219,7 @@ export class CodebuffClient {
           )
         }
         const toolDef = toolDefs[toolDefs.length - 1]
-        const handler = toolDef.handler
+        const handler = toolDef.execute
         try {
           return {
             output: toolDef.outputSchema.parse(

sdk/src/custom-tool.ts

@@ -5,8 +5,8 @@ import type { JSONSchema } from 'zod/v4/core'
 
 export type CustomToolDefinition<
   N extends string = string,
-  Args = any,
-  Input = any,
+  Args = unknown,
+  Input = unknown,
   Output extends ToolResultOutput[] = ToolResultOutput[],
 > = {
   toolName: N
@@ -16,9 +16,21 @@ export type CustomToolDefinition<
   description: string
   endsAgentStep: boolean
   exampleInputs: Input[]
-  handler: (params: Args) => Promise<Output>
+  execute: (params: Args) => Promise<Output>
 }
 
+/**
+ * Creates a CustomToolDefinition object
+ *
+ * @param toolName the name of the tool
+ * @param inputSchema a Zod4 schema describing the input of the tool.
+ * @param outputSchema a Zod4 schema describing the output of the tool.
+ * @param description a description of the tool to be passed to the LLM. This should describe what the tool does and when to use it.
+ * @param endsAgentStep whether the tool ends the agent step. If `true`, this will be used as a "stop sequence" for the LLM. i.e. it will not be able to call any other tools after this one in a single step and must wait for the tool results. Used for tools that give more information to the LLM.
+ * @param exampleInputs an array of example inputs for the tool.
+ * @param execute what to do when the tool is called.
+ * @returns The CustomToolDefinition object
+ */
 export function getCustomToolDefinition<
   ToolName extends string,
   Args,
@@ -31,15 +43,15 @@ export function getCustomToolDefinition<
   description,
   endsAgentStep = true,
   exampleInputs = [],
-  handler,
+  execute,
 }: {
   toolName: ToolName
   inputSchema: z.ZodType<Args, Input>
   outputSchema: z.ZodType<ToolResultOutput[], Output>
   description: string
   endsAgentStep?: boolean
   exampleInputs?: Input[]
-  handler: (params: Args) => Promise<Output>
+  execute: (params: Args) => Promise<Output>
 }): CustomToolDefinition<ToolName, Args, Input, Output> {
   return {
     toolName,
@@ -49,6 +61,6 @@ export function getCustomToolDefinition<
     description,
     endsAgentStep,
     exampleInputs,
-    handler,
+    execute,
   }
 }