sdk docs: Use getCustomToolDefinition. Fix typo. Flip default to endsAgentStep: true. Make description required.

Author: jahooma

sdk/README.md

@@ -73,6 +73,7 @@ import {
   CodebuffClient,
   generateInitialRunState,
   withAdditionalMessage,
+  getCustomToolDefinition,
 } from '@codebuff/sdk'
 
 // Available after running `codebuff login`
@@ -124,23 +125,30 @@ const result = await client.run({
 
   // Custom tool definitions
   customToolDefinitions: [
-    {
+    getCustomToolDefinition({
       toolName: 'fetch_api_data',
-      zodSchema: z
-        .object({
-          url: z.string().url(),
-          method: z.enum(['GET', 'POST']).default('GET'),
-          headers: z.record(z.string()).optional(),
-        })
-        .describe('Fetch data from an API endpoint'),
+      description: 'Fetch data from an API endpoint',
+      inputSchema: z.object({
+        url: z.string().url(),
+        method: z.enum(['GET', 'POST']).default('GET'),
+        headers: z.record(z.string()).optional(),
+      }),
+      exampleInputs: [
+        { url: 'https://api.example.com/data', method: 'GET' },
+        {
+          url: 'https://api.example.com/submit',
+          method: 'POST',
+          headers: { 'Content-Type': 'application/json' },
+        },
+      ],
       handler: async ({ url, method, headers }) => {
         const response = await fetch(url, { method, headers })
         const data = await response.text()
         return {
-          toolResultMessage: `API Response: ${data.slice(0, 500)}...`,
+          toolResultMessage: `API Response: ${data.slice(0, 5000)}...`,
         }
       },
-    },
+    }),
   ],
 
   handleEvent: (event) => {

sdk/package.json

@@ -2,7 +2,7 @@
   "name": "@codebuff/sdk",
   "private": false,
   "access": "public",
-  "version": "0.1.15",
+  "version": "0.1.16",
   "description": "Official SDK for Codebuff — AI coding agent & framework",
   "license": "MIT",
   "type": "module",

sdk/src/custom-tool.ts

@@ -10,29 +10,29 @@ export type CustomToolDefinition<
   toolName: N
   zodSchema: z.ZodType<Output, Input>
   inputJsonSchema: JSONSchema.BaseSchema
-  description?: string
+  description: string
   endsAgentStep: boolean
   exampleInputs: Input[]
   handler: (params: Output) => Promise<{
     toolResultMessage: string
   }>
 }
 
-export function getCustomToolDefinintion<
+export function getCustomToolDefinition<
   ToolName extends string,
   Output,
   Input,
 >({
   toolName,
   inputSchema,
   description,
-  endsAgentStep = false,
+  endsAgentStep = true,
   exampleInputs = [],
   handler,
 }: {
   toolName: ToolName
   inputSchema: z.ZodType<Output, Input>
-  description?: string
+  description: string
   endsAgentStep?: boolean
   exampleInputs?: Input[]
   handler: (params: Output) => Promise<{

sdk/src/index.ts

@@ -1,5 +1,5 @@
 export { CodebuffClient } from './client'
-export { getCustomToolDefinintion } from './custom-tool'
+export { getCustomToolDefinition } from './custom-tool'
 export {
   generateInitialRunState,
   initialSessionState,