fix(messages): updates for server tools

RobertCraigie · RobertCraigie · commit c2709b27b17a · 2025-05-07T21:27:14.000+01:00
diff --git a/examples/tools.ts b/examples/tools.ts
@@ -49,7 +49,7 @@ async function main() {
           {
             type: 'tool_result',
             tool_use_id: tool.id,
-            content: [{ type: 'text', text: 'The weather is 73f' }],
+            content: 'The weather is 73f',
           },
         ],
       },
diff --git a/examples/web-search-stream.ts b/examples/web-search-stream.ts
@@ -0,0 +1,64 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import Anthropic from '@anthropic-ai/sdk';
+
+const client = new Anthropic();
+
+async function main() {
+  console.log('Claude with Web Search (Streaming)');
+  console.log('==================================');
+
+  // Create a stream with web search enabled
+  const stream = client.messages
+    .stream({
+      model: 'claude-3-5-sonnet-latest',
+      max_tokens: 1024,
+      messages: [
+        {
+          role: 'user',
+          content: "What's the weather in New York?",
+        },
+      ],
+      tools: [
+        {
+          name: 'web_search',
+          type: 'web_search_20250305',
+        },
+      ],
+    })
+    .on('text', (text) => {
+      // Print text as it arrives
+      process.stdout.write(text);
+    })
+    .on('streamEvent', (event) => {
+      // Track when web search is being used
+      if (event.type === 'content_block_start' && event.content_block.type === 'web_search_tool_result') {
+        process.stdout.write('\n[Web search started...]');
+      }
+    });
+
+  // Wait for the stream to complete
+  const message = await stream.finalMessage();
+
+  console.log('\n\nFinal usage statistics:');
+  console.log(`Input tokens: ${message.usage.input_tokens}`);
+  console.log(`Output tokens: ${message.usage.output_tokens}`);
+
+  if (message.usage.server_tool_use) {
+    console.log(`Web search requests: ${message.usage.server_tool_use.web_search_requests}`);
+  } else {
+    console.log('No web search requests recorded in usage');
+  }
+
+  // Display message content types for debugging
+  console.log('\nMessage Content Types:');
+  message.content.forEach((block, i) => {
+    console.log(`Content Block ${i + 1}: Type = ${block.type}`);
+  });
+
+  // Show full message for debugging
+  console.log('\nComplete message structure:');
+  console.dir(message, { depth: 4 });
+}
+
+main().catch(console.error);
diff --git a/examples/web-search.ts b/examples/web-search.ts
@@ -0,0 +1,52 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import Anthropic from '@anthropic-ai/sdk';
+
+const client = new Anthropic();
+
+async function main() {
+  console.log('Web Search Example');
+  console.log('=================');
+
+  // Create a message with web search enabled
+  const message = await client.messages.create({
+    model: 'claude-3-5-sonnet-latest',
+    max_tokens: 1024,
+    messages: [
+      {
+        role: 'user',
+        content:
+          "What's the current weather in San Francisco? Please search the web for up-to-date information.",
+      },
+    ],
+    tools: [
+      {
+        name: 'web_search',
+        type: 'web_search_20250305',
+      },
+    ],
+  });
+
+  // Print the full response
+  console.log('\nFull response:');
+  console.dir(message, { depth: 4 });
+
+  // Extract and print the content
+  console.log('\nResponse content:');
+  for (const contentBlock of message.content) {
+    if (contentBlock.type === 'text') {
+      console.log(contentBlock.text);
+    }
+  }
+
+  // Print usage information
+  console.log('\nUsage statistics:');
+  console.log(`Input tokens: ${message.usage.input_tokens}`);
+  console.log(`Output tokens: ${message.usage.output_tokens}`);
+
+  if (message.usage.server_tool_use) {
+    console.log(`Web search requests: ${message.usage.server_tool_use.web_search_requests}`);
+  }
+}
+
+main().catch(console.error);
diff --git a/src/lib/BetaMessageStream.ts b/src/lib/BetaMessageStream.ts
@@ -531,6 +531,15 @@ export class BetaMessageStream implements AsyncIterable<BetaMessageStreamEvent>
         snapshot.stop_reason = event.delta.stop_reason;
         snapshot.stop_sequence = event.delta.stop_sequence;
         snapshot.usage.output_tokens = event.usage.output_tokens;
+
+        // Update other usage fields if they exist in the event
+        if (event.usage.input_tokens) {
+          snapshot.usage.input_tokens = event.usage.input_tokens;
+        }
+        snapshot.usage.cache_creation_input_tokens = event.usage.cache_creation_input_tokens;
+        snapshot.usage.cache_read_input_tokens = event.usage.cache_read_input_tokens;
+        snapshot.usage.server_tool_use = event.usage.server_tool_use;
+
         return snapshot;
       case 'content_block_start':
         snapshot.content.push(event.content_block);
diff --git a/src/lib/MessageStream.ts b/src/lib/MessageStream.ts
@@ -531,6 +531,15 @@ export class MessageStream implements AsyncIterable<MessageStreamEvent> {
         snapshot.stop_reason = event.delta.stop_reason;
         snapshot.stop_sequence = event.delta.stop_sequence;
         snapshot.usage.output_tokens = event.usage.output_tokens;
+
+        // Update other usage fields if they exist in the event
+        if (event.usage.input_tokens) {
+          snapshot.usage.input_tokens = event.usage.input_tokens;
+        }
+        snapshot.usage.cache_creation_input_tokens = event.usage.cache_creation_input_tokens;
+        snapshot.usage.cache_read_input_tokens = event.usage.cache_read_input_tokens;
+        snapshot.usage.server_tool_use = event.usage.server_tool_use;
+
         return snapshot;
       case 'content_block_start':
         snapshot.content.push(event.content_block);
diff --git a/tests/api-resources/MessageStream.test.ts b/tests/api-resources/MessageStream.test.ts
@@ -34,6 +34,19 @@ async function* messageIterable(message: Message): AsyncGenerator<MessageStreamE
           }
         : content.type === 'thinking' ? { type: 'thinking', thinking: '', signature: '' }
         : content.type === 'redacted_thinking' ? { type: 'redacted_thinking', data: '' }
+        : content.type === 'server_tool_use' ?
+          {
+            type: 'server_tool_use',
+            id: 'toolu_01Up7oRoHeGvhded7n66nPzP',
+            name: 'web_search',
+            input: {},
+          }
+        : content.type === 'web_search_tool_result' ?
+          {
+            type: 'web_search_tool_result',
+            tool_use_id: 'toolu_01Up7oRoHeGvhded7n66nPzP',
+            content: [],
+          }
         : assertNever(content),
       index: idx,
     };
@@ -60,6 +73,10 @@ async function* messageIterable(message: Message): AsyncGenerator<MessageStreamE
       throw new Error('thinking not implemented yet');
     } else if (content.type === 'redacted_thinking') {
       throw new Error('redacted_thinking not implemented yet');
+    } else if (content.type === 'server_tool_use') {
+      throw new Error('server_tool_use not implemented yet');
+    } else if (content.type === 'web_search_tool_result') {
+      throw new Error('web_search_tool_result not implemented yet');
     } else {
       assertNever(content);
     }
@@ -72,7 +89,13 @@ async function* messageIterable(message: Message): AsyncGenerator<MessageStreamE
 
   yield {
     type: 'message_delta',
-    usage: { output_tokens: 6 },
+    usage: {
+      output_tokens: 6,
+      input_tokens: null,
+      cache_creation_input_tokens: null,
+      cache_read_input_tokens: null,
+      server_tool_use: null,
+    },
     // @ts-ignore
     delta: { stop_reason: message.stop_reason, stop_sequence: message.stop_sequence },
   };
@@ -166,6 +189,7 @@ describe('MessageStream class', () => {
           input_tokens: 10,
           cache_creation_input_tokens: null,
           cache_read_input_tokens: null,
+          server_tool_use: null,
         },
       }),
     );
@@ -226,22 +250,22 @@ describe('MessageStream class', () => {
         },
         {
           "args": [
-            "{"type":"message_start","message":{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message_start","message":{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
         {
           "args": [
             "{"type":"content_block_start","content_block":{"type":"text","text":"","citations":null},"index":0}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
         {
           "args": [
             "{"type":"content_block_delta","delta":{"type":"text_delta","text":"Hello"},"index":0}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
@@ -255,7 +279,7 @@ describe('MessageStream class', () => {
         {
           "args": [
             "{"type":"content_block_delta","delta":{"type":"text_delta","text":" ther"},"index":0}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello ther","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello ther","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
@@ -269,7 +293,7 @@ describe('MessageStream class', () => {
         {
           "args": [
             "{"type":"content_block_delta","delta":{"type":"text_delta","text":"e!"},"index":0}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
@@ -283,7 +307,7 @@ describe('MessageStream class', () => {
         {
           "args": [
             "{"type":"content_block_stop","index":0}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":null,"stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
@@ -295,27 +319,27 @@ describe('MessageStream class', () => {
         },
         {
           "args": [
-            "{"type":"message_delta","usage":{"output_tokens":6},"delta":{"stop_reason":"end_turn","stop_sequence":null}}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message_delta","usage":{"output_tokens":6,"input_tokens":null,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null},"delta":{"stop_reason":"end_turn","stop_sequence":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
         {
           "args": [
             "{"type":"message_stop"}",
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "streamEvent",
         },
         {
           "args": [
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "message",
         },
         {
           "args": [
-            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null}}",
+            "{"type":"message","id":"msg_01hhptzfxdaeehfxfv070yb6b8","role":"assistant","content":[{"type":"text","text":"Hello there!","citations":null}],"model":"claude-3-opus-20240229","stop_reason":"end_turn","stop_sequence":null,"usage":{"output_tokens":6,"input_tokens":10,"cache_creation_input_tokens":null,"cache_read_input_tokens":null,"server_tool_use":null}}",
           ],
           "type": "finalMessage",
         },
@@ -348,6 +372,7 @@ describe('MessageStream class', () => {
           "cache_read_input_tokens": null,
           "input_tokens": 10,
           "output_tokens": 6,
+          "server_tool_use": null,
         },
       }
     `);
@@ -378,6 +403,7 @@ describe('MessageStream class', () => {
           input_tokens: 10,
           cache_creation_input_tokens: null,
           cache_read_input_tokens: null,
+          server_tool_use: null,
         },
       }),
     );
@@ -405,7 +431,7 @@ describe('MessageStream class', () => {
     const stream = anthropic.messages.stream(
       {
         max_tokens: 1024,
-        model: 'claude-2.1',
+        model: 'claude-3-7-sonnet-20250219',
         messages: [{ role: 'user', content: 'Say hello there!' }],
       },
       { maxRetries: 0 },
@@ -430,7 +456,7 @@ describe('MessageStream class', () => {
     const stream = anthropic.messages.stream(
       {
         max_tokens: 1024,
-        model: 'claude-2.1',
+        model: 'claude-3-7-sonnet-20250219',
         messages: [{ role: 'user', content: 'Say hello there!' }],
       },
       { maxRetries: 0 },

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ async function main() {`
`49`	`49`	`{`
`50`	`50`	`type: 'tool_result',`
`51`	`51`	`tool_use_id: tool.id,`
`52`		`- content: [{ type: 'text', text: 'The weather is 73f' }],`
	`52`	`+ content: 'The weather is 73f',`
`53`	`53`	`},`
`54`	`54`	`],`
`55`	`55`	`},`