Update agent-definition.ts

Author: brandonkachen

.agents/types/agent-definition.ts

@@ -18,6 +18,17 @@ import type * as Tools from './tools'
 import type { Message, ToolResultOutput, JsonObjectSchema } from './util-types'
 type ToolName = Tools.ToolName
 
+// ============================================================================
+// Logger Interface
+// ============================================================================
+
+export interface Logger {
+  debug: (data: any, msg?: string) => void
+  info: (data: any, msg?: string) => void
+  warn: (data: any, msg?: string) => void
+  error: (data: any, msg?: string) => void
+}
+
 // ============================================================================
 // Agent Definition and Utility Types
 // ============================================================================
@@ -144,14 +155,16 @@ export interface AgentDefinition {
    * Or use 'return' to end the turn.
    *
    * Example 1:
-   * function* handleSteps({ agentStep, prompt, params}) {
+   * function* handleSteps({ agentStep, prompt, params}, logger) {
+   *   logger.info('Starting file read process')
    *   const { toolResult } = yield {
    *     toolName: 'read_files',
    *     input: { paths: ['file1.txt', 'file2.txt'] }
    *   }
    *   yield 'STEP_ALL'
    *
    *   // Optionally do a post-processing step here...
+   *   logger.info('Files read successfully, setting output')
    *   yield {
    *     toolName: 'set_output',
    *     input: {
@@ -161,8 +174,9 @@ export interface AgentDefinition {
    * }
    *
    * Example 2:
-   * handleSteps: function* ({ agentState, prompt, params }) {
+   * handleSteps: function* ({ agentState, prompt, params }, logger) {
    *   while (true) {
+   *     logger.debug('Spawning thinker agent')
    *     yield {
    *       toolName: 'spawn_agents',
    *       input: {
@@ -218,16 +232,6 @@ export interface AgentStepContext {
   params?: Record<string, any>
 }
 
-/**
- * Logger interface for handleSteps
- */
-export interface Logger {
-  debug: (data: any, msg?: string) => void
-  info: (data: any, msg?: string) => void
-  warn: (data: any, msg?: string) => void
-  error: (data: any, msg?: string) => void
-}
-
 /**
  * Tool call object for handleSteps generator
  */

common/src/templates/initial-agents-dir/types/agent-definition.ts

@@ -18,6 +18,17 @@ import type * as Tools from './tools'
 import type { Message, ToolResultOutput, JsonObjectSchema } from './util-types'
 type ToolName = Tools.ToolName
 
+// ============================================================================
+// Logger Interface
+// ============================================================================
+
+export interface Logger {
+  debug: (data: any, msg?: string) => void
+  info: (data: any, msg?: string) => void
+  warn: (data: any, msg?: string) => void
+  error: (data: any, msg?: string) => void
+}
+
 // ============================================================================
 // Agent Definition and Utility Types
 // ============================================================================
@@ -144,14 +155,16 @@ export interface AgentDefinition {
    * Or use 'return' to end the turn.
    *
    * Example 1:
-   * function* handleSteps({ agentStep, prompt, params}) {
+   * function* handleSteps({ agentStep, prompt, params}, logger) {
+   *   logger.info('Starting file read process')
    *   const { toolResult } = yield {
    *     toolName: 'read_files',
    *     input: { paths: ['file1.txt', 'file2.txt'] }
    *   }
    *   yield 'STEP_ALL'
    *
    *   // Optionally do a post-processing step here...
+   *   logger.info('Files read successfully, setting output')
    *   yield {
    *     toolName: 'set_output',
    *     input: {
@@ -161,8 +174,9 @@ export interface AgentDefinition {
    * }
    *
    * Example 2:
-   * handleSteps: function* ({ agentState, prompt, params }) {
+   * handleSteps: function* ({ agentState, prompt, params }, logger) {
    *   while (true) {
+   *     logger.debug('Spawning thinker agent')
    *     yield {
    *       toolName: 'spawn_agents',
    *       input: {
@@ -179,7 +193,10 @@ export interface AgentDefinition {
    * }
    * }
    */
-  handleSteps?: (context: AgentStepContext) => Generator<
+  handleSteps?: (
+    context: AgentStepContext,
+    logger: Logger,
+  ) => Generator<
     ToolCall | 'STEP' | 'STEP_ALL',
     void,
     {