@ai-sdk/anthropic 3.0.17 → 3.0.19

package/src/tool/computer_20250124.ts

@@ -0,0 +1,130 @@
+import {
+  createProviderToolFactory,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+const computer_20250124InputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      action: z.enum([
+        'key',
+        'hold_key',
+        'type',
+        'cursor_position',
+        'mouse_move',
+        'left_mouse_down',
+        'left_mouse_up',
+        'left_click',
+        'left_click_drag',
+        'right_click',
+        'middle_click',
+        'double_click',
+        'triple_click',
+        'scroll',
+        'wait',
+        'screenshot',
+      ]),
+      coordinate: z.tuple([z.number().int(), z.number().int()]).optional(),
+      duration: z.number().optional(),
+      scroll_amount: z.number().optional(),
+      scroll_direction: z.enum(['up', 'down', 'left', 'right']).optional(),
+      start_coordinate: z
+        .tuple([z.number().int(), z.number().int()])
+        .optional(),
+      text: z.string().optional(),
+    }),
+  ),
+);
+
+export const computer_20250124 = createProviderToolFactory<
+  {
+    /**
+     * - `key`: Press a key or key-combination on the keyboard.
+     *   - This supports xdotool's `key` syntax.
+     *   - Examples: "a", "Return", "alt+Tab", "ctrl+s", "Up", "KP_0" (for the numpad 0 key).
+     * - `hold_key`: Hold down a key or multiple keys for a specified duration (in seconds). Supports the same syntax as `key`.
+     * - `type`: Type a string of text on the keyboard.
+     * - `cursor_position`: Get the current (x, y) pixel coordinate of the cursor on the screen.
+     * - `mouse_move`: Move the cursor to a specified (x, y) pixel coordinate on the screen.
+     * - `left_mouse_down`: Press the left mouse button.
+     * - `left_mouse_up`: Release the left mouse button.
+     * - `left_click`: Click the left mouse button at the specified (x, y) pixel coordinate on the screen. You can also include a key combination to hold down while clicking using the `text` parameter.
+     * - `left_click_drag`: Click and drag the cursor from `start_coordinate` to a specified (x, y) pixel coordinate on the screen.
+     * - `right_click`: Click the right mouse button at the specified (x, y) pixel coordinate on the screen.
+     * - `middle_click`: Click the middle mouse button at the specified (x, y) pixel coordinate on the screen.
+     * - `double_click`: Double-click the left mouse button at the specified (x, y) pixel coordinate on the screen.
+     * - `triple_click`: Triple-click the left mouse button at the specified (x, y) pixel coordinate on the screen.
+     * - `scroll`: Scroll the screen in a specified direction by a specified amount of clicks of the scroll wheel, at the specified (x, y) pixel coordinate. DO NOT use PageUp/PageDown to scroll.
+     * - `wait`: Wait for a specified duration (in seconds).
+     * - `screenshot`: Take a screenshot of the screen.
+     */
+    action:
+      | 'key'
+      | 'hold_key'
+      | 'type'
+      | 'cursor_position'
+      | 'mouse_move'
+      | 'left_mouse_down'
+      | 'left_mouse_up'
+      | 'left_click'
+      | 'left_click_drag'
+      | 'right_click'
+      | 'middle_click'
+      | 'double_click'
+      | 'triple_click'
+      | 'scroll'
+      | 'wait'
+      | 'screenshot';
+
+    /**
+     * (x, y): The x (pixels from the left edge) and y (pixels from the top edge) coordinates to move the mouse to. Required only by `action=mouse_move` and `action=left_click_drag`.
+     */
+    coordinate?: [number, number];
+
+    /**
+     * The duration to hold the key down for. Required only by `action=hold_key` and `action=wait`.
+     */
+    duration?: number;
+
+    /**
+     * The number of 'clicks' to scroll. Required only by `action=scroll`.
+     */
+    scroll_amount?: number;
+
+    /**
+     * The direction to scroll the screen. Required only by `action=scroll`.
+     */
+    scroll_direction?: 'up' | 'down' | 'left' | 'right';
+
+    /**
+     * (x, y): The x (pixels from the left edge) and y (pixels from the top edge) coordinates to start the drag from. Required only by `action=left_click_drag`.
+     */
+    start_coordinate?: [number, number];
+
+    /**
+     * Required only by `action=type`, `action=key`, and `action=hold_key`. Can also be used by click or scroll actions to hold down keys while clicking or scrolling.
+     */
+    text?: string;
+  },
+  {
+    /**
+     * The width of the display being controlled by the model in pixels.
+     */
+    displayWidthPx: number;
+
+    /**
+     * The height of the display being controlled by the model in pixels.
+     */
+    displayHeightPx: number;
+
+    /**
+     * The display number to control (only relevant for X11 environments). If specified, the tool will be provided a display number in the tool definition.
+     */
+    displayNumber?: number;
+  }
+>({
+  id: 'anthropic.computer_20250124',
+  inputSchema: computer_20250124InputSchema,
+});

package/src/tool/memory_20250818.ts

@@ -0,0 +1,62 @@
+import {
+  createProviderToolFactory,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+const memory_20250818InputSchema = lazySchema(() =>
+  zodSchema(
+    z.discriminatedUnion('command', [
+      z.object({
+        command: z.literal('view'),
+        path: z.string(),
+        view_range: z.tuple([z.number(), z.number()]).optional(),
+      }),
+      z.object({
+        command: z.literal('create'),
+        path: z.string(),
+        file_text: z.string(),
+      }),
+      z.object({
+        command: z.literal('str_replace'),
+        path: z.string(),
+        old_str: z.string(),
+        new_str: z.string(),
+      }),
+      z.object({
+        command: z.literal('insert'),
+        path: z.string(),
+        insert_line: z.number(),
+        insert_text: z.string(),
+      }),
+      z.object({
+        command: z.literal('delete'),
+        path: z.string(),
+      }),
+      z.object({
+        command: z.literal('rename'),
+        old_path: z.string(),
+        new_path: z.string(),
+      }),
+    ]),
+  ),
+);
+
+export const memory_20250818 = createProviderToolFactory<
+  | { command: 'view'; path: string; view_range?: [number, number] }
+  | { command: 'create'; path: string; file_text: string }
+  | { command: 'str_replace'; path: string; old_str: string; new_str: string }
+  | {
+      command: 'insert';
+      path: string;
+      insert_line: number;
+      insert_text: string;
+    }
+  | { command: 'delete'; path: string }
+  | { command: 'rename'; old_path: string; new_path: string },
+  {}
+>({
+  id: 'anthropic.memory_20250818',
+  inputSchema: memory_20250818InputSchema,
+});

package/src/tool/text-editor_20241022.ts

@@ -0,0 +1,63 @@
+import {
+  createProviderToolFactory,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+const textEditor_20241022InputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      command: z.enum(['view', 'create', 'str_replace', 'insert', 'undo_edit']),
+      path: z.string(),
+      file_text: z.string().optional(),
+      insert_line: z.number().int().optional(),
+      new_str: z.string().optional(),
+      old_str: z.string().optional(),
+      view_range: z.array(z.number().int()).optional(),
+    }),
+  ),
+);
+
+export const textEditor_20241022 = createProviderToolFactory<
+  {
+    /**
+     * The commands to run. Allowed options are: `view`, `create`, `str_replace`, `insert`, `undo_edit`.
+     */
+    command: 'view' | 'create' | 'str_replace' | 'insert' | 'undo_edit';
+
+    /**
+     * Absolute path to file or directory, e.g. `/repo/file.py` or `/repo`.
+     */
+    path: string;
+
+    /**
+     * Required parameter of `create` command, with the content of the file to be created.
+     */
+    file_text?: string;
+
+    /**
+     * Required parameter of `insert` command. The `new_str` will be inserted AFTER the line `insert_line` of `path`.
+     */
+    insert_line?: number;
+
+    /**
+     * Optional parameter of `str_replace` command containing the new string (if not given, no string will be added). Required parameter of `insert` command containing the string to insert.
+     */
+    new_str?: string;
+
+    /**
+     * Required parameter of `str_replace` command containing the string in `path` to replace.
+     */
+    old_str?: string;
+
+    /**
+     * Optional parameter of `view` command when `path` points to a file. If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[start_line, -1]` shows all lines from `start_line` to the end of the file.
+     */
+    view_range?: number[];
+  },
+  {}
+>({
+  id: 'anthropic.text_editor_20241022',
+  inputSchema: textEditor_20241022InputSchema,
+});

package/src/tool/text-editor_20250124.ts

@@ -0,0 +1,63 @@
+import {
+  createProviderToolFactory,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+const textEditor_20250124InputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      command: z.enum(['view', 'create', 'str_replace', 'insert', 'undo_edit']),
+      path: z.string(),
+      file_text: z.string().optional(),
+      insert_line: z.number().int().optional(),
+      new_str: z.string().optional(),
+      old_str: z.string().optional(),
+      view_range: z.array(z.number().int()).optional(),
+    }),
+  ),
+);
+
+export const textEditor_20250124 = createProviderToolFactory<
+  {
+    /**
+     * The commands to run. Allowed options are: `view`, `create`, `str_replace`, `insert`, `undo_edit`.
+     */
+    command: 'view' | 'create' | 'str_replace' | 'insert' | 'undo_edit';
+
+    /**
+     * Absolute path to file or directory, e.g. `/repo/file.py` or `/repo`.
+     */
+    path: string;
+
+    /**
+     * Required parameter of `create` command, with the content of the file to be created.
+     */
+    file_text?: string;
+
+    /**
+     * Required parameter of `insert` command. The `new_str` will be inserted AFTER the line `insert_line` of `path`.
+     */
+    insert_line?: number;
+
+    /**
+     * Optional parameter of `str_replace` command containing the new string (if not given, no string will be added). Required parameter of `insert` command containing the string to insert.
+     */
+    new_str?: string;
+
+    /**
+     * Required parameter of `str_replace` command containing the string in `path` to replace.
+     */
+    old_str?: string;
+
+    /**
+     * Optional parameter of `view` command when `path` points to a file. If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[start_line, -1]` shows all lines from `start_line` to the end of the file.
+     */
+    view_range?: number[];
+  },
+  {}
+>({
+  id: 'anthropic.text_editor_20250124',
+  inputSchema: textEditor_20250124InputSchema,
+});

package/src/tool/text-editor_20250429.ts

@@ -0,0 +1,64 @@
+import {
+  createProviderToolFactory,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+const textEditor_20250429InputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      command: z.enum(['view', 'create', 'str_replace', 'insert']),
+      path: z.string(),
+      file_text: z.string().optional(),
+      insert_line: z.number().int().optional(),
+      new_str: z.string().optional(),
+      old_str: z.string().optional(),
+      view_range: z.array(z.number().int()).optional(),
+    }),
+  ),
+);
+
+export const textEditor_20250429 = createProviderToolFactory<
+  {
+    /**
+     * The commands to run. Allowed options are: `view`, `create`, `str_replace`, `insert`.
+     * Note: `undo_edit` is not supported in Claude 4 models.
+     */
+    command: 'view' | 'create' | 'str_replace' | 'insert';
+
+    /**
+     * Absolute path to file or directory, e.g. `/repo/file.py` or `/repo`.
+     */
+    path: string;
+
+    /**
+     * Required parameter of `create` command, with the content of the file to be created.
+     */
+    file_text?: string;
+
+    /**
+     * Required parameter of `insert` command. The `new_str` will be inserted AFTER the line `insert_line` of `path`.
+     */
+    insert_line?: number;
+
+    /**
+     * Optional parameter of `str_replace` command containing the new string (if not given, no string will be added). Required parameter of `insert` command containing the string to insert.
+     */
+    new_str?: string;
+
+    /**
+     * Required parameter of `str_replace` command containing the string in `path` to replace.
+     */
+    old_str?: string;
+
+    /**
+     * Optional parameter of `view` command when `path` points to a file. If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[start_line, -1]` shows all lines from `start_line` to the end of the file.
+     */
+    view_range?: number[];
+  },
+  {}
+>({
+  id: 'anthropic.text_editor_20250429',
+  inputSchema: textEditor_20250429InputSchema,
+});

package/src/tool/text-editor_20250728.ts

@@ -0,0 +1,80 @@
+import { createProviderToolFactory } from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+import { lazySchema, zodSchema } from '@ai-sdk/provider-utils';
+
+export const textEditor_20250728ArgsSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      maxCharacters: z.number().optional(),
+    }),
+  ),
+);
+
+const textEditor_20250728InputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      command: z.enum(['view', 'create', 'str_replace', 'insert']),
+      path: z.string(),
+      file_text: z.string().optional(),
+      insert_line: z.number().int().optional(),
+      new_str: z.string().optional(),
+      old_str: z.string().optional(),
+      view_range: z.array(z.number().int()).optional(),
+    }),
+  ),
+);
+
+const factory = createProviderToolFactory<
+  {
+    /**
+     * The commands to run. Allowed options are: `view`, `create`, `str_replace`, `insert`.
+     * Note: `undo_edit` is not supported in Claude 4 models.
+     */
+    command: 'view' | 'create' | 'str_replace' | 'insert';
+
+    /**
+     * Absolute path to file or directory, e.g. `/repo/file.py` or `/repo`.
+     */
+    path: string;
+
+    /**
+     * Required parameter of `create` command, with the content of the file to be created.
+     */
+    file_text?: string;
+
+    /**
+     * Required parameter of `insert` command. The `new_str` will be inserted AFTER the line `insert_line` of `path`.
+     */
+    insert_line?: number;
+
+    /**
+     * Optional parameter of `str_replace` command containing the new string (if not given, no string will be added). Required parameter of `insert` command containing the string to insert.
+     */
+    new_str?: string;
+
+    /**
+     * Required parameter of `str_replace` command containing the string in `path` to replace.
+     */
+    old_str?: string;
+
+    /**
+     * Optional parameter of `view` command when `path` points to a file. If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[start_line, -1]` shows all lines from `start_line` to the end of the file.
+     */
+    view_range?: number[];
+  },
+  {
+    /**
+     * Optional parameter to control truncation when viewing large files. Only compatible with text_editor_20250728 and later versions.
+     */
+    maxCharacters?: number;
+  }
+>({
+  id: 'anthropic.text_editor_20250728',
+  inputSchema: textEditor_20250728InputSchema,
+});
+
+export const textEditor_20250728 = (
+  args: Parameters<typeof factory>[0] = {}, // default
+) => {
+  return factory(args);
+};

package/src/tool/tool-search-bm25_20251119.ts

@@ -0,0 +1,98 @@
+import {
+  createProviderToolFactoryWithOutputSchema,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+/**
+ * Output schema for tool search results - returns tool references
+ * that are automatically expanded into full tool definitions by the API.
+ */
+export const toolSearchBm25_20251119OutputSchema = lazySchema(() =>
+  zodSchema(
+    z.array(
+      z.object({
+        type: z.literal('tool_reference'),
+        toolName: z.string(),
+      }),
+    ),
+  ),
+);
+
+/**
+ * Input schema for BM25-based tool search.
+ * Claude uses natural language queries to search for tools.
+ */
+const toolSearchBm25_20251119InputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      /**
+       * A natural language query to search for tools.
+       * Claude will use BM25 text search to find relevant tools.
+       */
+      query: z.string(),
+      /**
+       * Maximum number of tools to return. Optional.
+       */
+      limit: z.number().optional(),
+    }),
+  ),
+);
+
+const factory = createProviderToolFactoryWithOutputSchema<
+  {
+    /**
+     * A natural language query to search for tools.
+     * Claude will use BM25 text search to find relevant tools.
+     */
+    query: string;
+    /**
+     * Maximum number of tools to return. Optional.
+     */
+    limit?: number;
+  },
+  Array<{
+    type: 'tool_reference';
+    /**
+     * The name of the discovered tool.
+     */
+    toolName: string;
+  }>,
+  {}
+>({
+  id: 'anthropic.tool_search_bm25_20251119',
+  inputSchema: toolSearchBm25_20251119InputSchema,
+  outputSchema: toolSearchBm25_20251119OutputSchema,
+});
+
+/**
+ * Creates a tool search tool that uses BM25 (natural language) to find tools.
+ *
+ * The tool search tool enables Claude to work with hundreds or thousands of tools
+ * by dynamically discovering and loading them on-demand. Instead of loading all
+ * tool definitions into the context window upfront, Claude searches your tool
+ * catalog and loads only the tools it needs.
+ *
+ * When Claude uses this tool, it uses natural language queries (NOT regex patterns)
+ * to search for tools using BM25 text search.
+ *
+ * **Important**: This tool should never have `deferLoading: true` in providerOptions.
+ *
+ * @example
+ * ```ts
+ * import { anthropicTools } from '@ai-sdk/anthropic';
+ *
+ * const tools = {
+ *   toolSearch: anthropicTools.toolSearchBm25_20251119(),
+ *   // Other tools with deferLoading...
+ * };
+ * ```
+ *
+ * @see https://docs.anthropic.com/en/docs/agents-and-tools/tool-search-tool
+ */
+export const toolSearchBm25_20251119 = (
+  args: Parameters<typeof factory>[0] = {},
+) => {
+  return factory(args);
+};

package/src/tool/tool-search-regex_20251119.ts

@@ -0,0 +1,110 @@
+import {
+  createProviderToolFactoryWithOutputSchema,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+/**
+ * Output schema for tool search results - returns tool references
+ * that are automatically expanded into full tool definitions by the API.
+ */
+export const toolSearchRegex_20251119OutputSchema = lazySchema(() =>
+  zodSchema(
+    z.array(
+      z.object({
+        type: z.literal('tool_reference'),
+        toolName: z.string(),
+      }),
+    ),
+  ),
+);
+
+/**
+ * Input schema for regex-based tool search.
+ * Claude constructs regex patterns using Python's re.search() syntax.
+ */
+const toolSearchRegex_20251119InputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      /**
+       * A regex pattern to search for tools.
+       * Uses Python re.search() syntax. Maximum 200 characters.
+       *
+       * Examples:
+       * - "weather" - matches tool names/descriptions containing "weather"
+       * - "get_.*_data" - matches tools like get_user_data, get_weather_data
+       * - "database.*query|query.*database" - OR patterns for flexibility
+       * - "(?i)slack" - case-insensitive search
+       */
+      pattern: z.string(),
+      /**
+       * Maximum number of tools to return. Optional.
+       */
+      limit: z.number().optional(),
+    }),
+  ),
+);
+
+const factory = createProviderToolFactoryWithOutputSchema<
+  {
+    /**
+     * A regex pattern to search for tools.
+     * Uses Python re.search() syntax. Maximum 200 characters.
+     *
+     * Examples:
+     * - "weather" - matches tool names/descriptions containing "weather"
+     * - "get_.*_data" - matches tools like get_user_data, get_weather_data
+     * - "database.*query|query.*database" - OR patterns for flexibility
+     * - "(?i)slack" - case-insensitive search
+     */
+    pattern: string;
+    /**
+     * Maximum number of tools to return. Optional.
+     */
+    limit?: number;
+  },
+  Array<{
+    type: 'tool_reference';
+    /**
+     * The name of the discovered tool.
+     */
+    toolName: string;
+  }>,
+  {}
+>({
+  id: 'anthropic.tool_search_regex_20251119',
+  inputSchema: toolSearchRegex_20251119InputSchema,
+  outputSchema: toolSearchRegex_20251119OutputSchema,
+});
+
+/**
+ * Creates a tool search tool that uses regex patterns to find tools.
+ *
+ * The tool search tool enables Claude to work with hundreds or thousands of tools
+ * by dynamically discovering and loading them on-demand. Instead of loading all
+ * tool definitions into the context window upfront, Claude searches your tool
+ * catalog and loads only the tools it needs.
+ *
+ * When Claude uses this tool, it constructs regex patterns using Python's
+ * re.search() syntax (NOT natural language queries).
+ *
+ * **Important**: This tool should never have `deferLoading: true` in providerOptions.
+ *
+ * @example
+ * ```ts
+ * import { anthropicTools } from '@ai-sdk/anthropic';
+ *
+ * const tools = {
+ *   toolSearch: anthropicTools.toolSearchRegex_20251119(),
+ *   // Other tools with deferLoading...
+ * };
+ * ```
+ *
+ * @see https://docs.anthropic.com/en/docs/agents-and-tools/tool-search-tool
+ */
+export const toolSearchRegex_20251119 = (
+  args: Parameters<typeof factory>[0] = {},
+) => {
+  return factory(args);
+};