Add "tags" to user message auxiliary schema. Deprecate timeToLive, keepDuringTruncation, keepLastTags

Author: jahooma

common/src/types/messages/codebuff-message.ts

@@ -12,10 +12,18 @@ import { providerMetadataSchema } from './provider-metadata'
 
 const auxiliaryDataSchema = z.object({
   providerOptions: providerMetadataSchema.optional(),
+
+  tags: z.string().array().optional(),
+
+  // James: All the below is overly prescriptive for the framework.
+  // Instead, let's tag what the message is, and let the user decide time to live, keep during truncation, etc.
+  /** @deprecated Use tags instead. */
   timeToLive: z
     .union([z.literal('agentStep'), z.literal('userPrompt')])
     .optional(),
+  /** @deprecated Use tags instead. */
   keepDuringTruncation: z.boolean().optional(),
+  /** @deprecated Use tags instead. */
   keepLastTags: z.string().array().optional(),
 })
 

common/src/util/messages.ts

@@ -202,7 +202,8 @@ export function convertCbToModelMessages({
     const lastMessage = aggregated[aggregated.length - 1]
     if (
       lastMessage.timeToLive !== message.timeToLive ||
-      !isEqual(lastMessage.providerOptions, message.providerOptions)
+      !isEqual(lastMessage.providerOptions, message.providerOptions) ||
+      !isEqual(lastMessage.tags, message.tags)
     ) {
       aggregated.push(message)
       continue
@@ -227,9 +228,15 @@ export function convertCbToModelMessages({
     return aggregated
   }
 
-  // add cache control to specific messages
-  for (const ttl of ['agentStep', 'userPrompt'] as const) {
-    const index = aggregated.findIndex((m) => m.timeToLive === ttl)
+  // Add cache control to specific messages (max of 4 can be marked for caching!):
+  // - The message right before the three tagged messages
+  // - Last message
+  for (const tag of [
+    'USER_PROMPT',
+    'INSTRUCTIONS_PROMPT',
+    'STEP_PROMPT',
+  ] as const) {
+    const index = aggregated.findLastIndex((m) => m.tags?.includes(tag))
     if (index <= 0) {
       continue
     }

packages/agent-runtime/src/run-agent-step.ts

@@ -223,6 +223,9 @@ export const runAgentStep = async (
     stepPrompt && {
       role: 'user' as const,
       content: stepPrompt,
+      tags: ['STEP_PROMPT'],
+
+      // James: Deprecate the below, only use tags, which are not prescriptive.
       timeToLive: 'agentStep' as const,
       keepDuringTruncation: true,
     },
@@ -567,6 +570,9 @@ export async function loopAgentSteps(
         // Actual user message!
         role: 'user' as const,
         content: buildUserMessageContent(prompt, spawnParams, content),
+        tags: ['USER_PROMPT'],
+
+        // James: Deprecate the below, only use tags, which are not prescriptive.
         keepDuringTruncation: true,
       },
       prompt &&
@@ -583,6 +589,9 @@ export async function loopAgentSteps(
     instructionsPrompt && {
       role: 'user' as const,
       content: instructionsPrompt,
+      tags: ['INSTRUCTIONS_PROMPT'],
+
+      // James: Deprecate the below, only use tags, which are not prescriptive.
       keepLastTags: ['INSTRUCTIONS_PROMPT'],
     },
   )

packages/agent-runtime/src/templates/strings.ts

@@ -214,6 +214,10 @@ export async function getAgentPrompt<T extends StringField>(
     spawnableAgents: agentTemplate.spawnableAgents,
   })
 
+  if (prompt.trim() === '') {
+    return undefined
+  }
+
   let addendum = ''
 
   if (promptType.type === 'stepPrompt' && agentState.agentType && prompt) {