GitHub

API reference for tool.

Anthropic's provider-defined tools (Effect's AnthropicTool).

Each constant is a tool's constructor: call it with the tool's arguments to put it in a toolkit. Tools Anthropic runs (code execution, web search, web fetch, tool search) need no handler; the client tools (bash, the text editor, computer use, memory) do::

kit = toolkit.make(tool.WebSearch_20250305(max_uses=3), tool.Bash_20250124())

Arguments use Effect's camelCase names (maxUses, displayWidthPx) as keywords or a mapping. The results of server tools are Anthropic's JSON blocks, unchanged.

Values

AttributeTypeDescription
Bash_20241022(...) -> ProviderDefined[Literal['AnthropicBash'], BashParameters, str, Never, Never, Never]
Bash_20250124(...) -> ProviderDefined[Literal['AnthropicBash'], BashParameters, str, Never, Never, Never]
CodeExecution_20250522(...) -> ProviderDefined[Literal['AnthropicCodeExecution'], CodeExecutionProgrammaticToolCall | CodeExecutionBashCommand | CodeExecutionTextEditorView | CodeExecutionTextEditorCreate | CodeExecutionTextEditorStrReplace, dict[str, object], dict[str, object], dict[str, object], Never]
CodeExecution_20250825(...) -> ProviderDefined[Literal['AnthropicCodeExecution'], CodeExecutionProgrammaticToolCall | CodeExecutionBashCommand | CodeExecutionTextEditorView | CodeExecutionTextEditorCreate | CodeExecutionTextEditorStrReplace, dict[str, object], dict[str, object], dict[str, object], Never]
ComputerUse_20241022(...) -> ProviderDefined[Literal['AnthropicComputerUse'], KeyAction | LeftClickAction | MouseMoveAction | ScreenshotAction | TypeAction, str, Never, Never, Never]
ComputerUse_20250124(...) -> ProviderDefined[Literal['AnthropicComputerUse'], KeyAction | LeftClickAction | MouseMoveAction | ScreenshotAction | TypeAction | DoubleClickAction | HoldKeyAction | LeftClickDragAction | LeftMouseDownAction | LeftMouseUpAction | MiddleClickAction | RightClickAction | ScrollAction | TripleClickAction | WaitAction, str, Never, Never, Never]
ComputerUse_20251124(...) -> ProviderDefined[Literal['AnthropicComputerUse'], KeyAction | LeftClickAction | MouseMoveAction | ScreenshotAction | TypeAction | DoubleClickAction | HoldKeyAction | LeftClickDragAction | LeftMouseDownAction | LeftMouseUpAction | MiddleClickAction | RightClickAction | ScrollAction | TripleClickAction | WaitAction | ZoomAction, str, Never, Never, Never]
Memory_20250818(...) -> ProviderDefined[Literal['AnthropicMemory'], MemoryCreateCommand | MemoryDeleteCommand | MemoryInsertCommand | MemoryRenameCommand | StrReplaceCommand | ViewCommand, str, Never, Never, Never]
TextEditor_20241022(...) -> ProviderDefined[Literal['AnthropicTextEditor'], ViewCommand | CreateCommand | StrReplaceCommand | InsertCommand | UndoEditCommand, str, Never, Never, Never]
TextEditor_20250124(...) -> ProviderDefined[Literal['AnthropicTextEditor'], ViewCommand | CreateCommand | StrReplaceCommand | InsertCommand | UndoEditCommand, str, Never, Never, Never]
TextEditor_20250429(...) -> ProviderDefined[Literal['AnthropicTextEditor'], ViewCommand | CreateCommand | StrReplaceCommand | InsertTextCommand, str, Never, Never, Never]
TextEditor_20250728(...) -> ProviderDefined[Literal['AnthropicTextEditor'], ViewCommand | CreateCommand | StrReplaceCommand | InsertTextCommand, str, Never, Never, Never]
WebSearch_20250305(...) -> ProviderDefined[Literal['AnthropicWebSearch'], QueryParameters, tuple[dict[str, object], ...], dict[str, object], dict[str, object], Never]
WebFetch_20250910(...) -> ProviderDefined[Literal['AnthropicWebFetch'], WebFetchParameters, dict[str, object], dict[str, object], dict[str, object], Never]
ToolSearchRegex_20251119(...) -> ProviderDefined[Literal['AnthropicToolSearchRegex'], ToolSearchRegexParameters, tuple[dict[str, object], ...], dict[str, object], dict[str, object], Never]
ToolSearchBM25_20251119(...) -> ProviderDefined[Literal['AnthropicToolSearchBM25'], ToolSearchBM25Parameters, tuple[dict[str, object], ...], dict[str, object], dict[str, object], Never]

Types

TypeDefinitionDescription
Coordinatetype Coordinate = tuple[int, int]
Regiontype Region = tuple[int, int, int, int]
ComputerUse_20241022_Actiontype ComputerUse_20241022_Action = KeyAction | LeftClickAction | MouseMoveAction | ScreenshotAction | TypeAction
ComputerUse_20250124_Actiontype ComputerUse_20250124_Action = ComputerUse_20241022_Action | DoubleClickAction | HoldKeyAction | LeftClickDragAction | LeftMouseDownAction | LeftMouseUpAction | MiddleClickAction | RightClickAction | ScrollAction | TripleClickAction | WaitAction
ComputerUse_20251124_Actiontype ComputerUse_20251124_Action = ComputerUse_20250124_Action | ZoomAction
ViewRangetype ViewRange = tuple[int, int]
MemoryCommandtype MemoryCommand = MemoryCreateCommand | MemoryDeleteCommand | MemoryInsertCommand | MemoryRenameCommand | StrReplaceCommand | ViewCommand
StrReplaceBasedEditCommandtype StrReplaceBasedEditCommand = ViewCommand | CreateCommand | StrReplaceCommand | InsertTextCommand
StrReplaceEditorCommandtype StrReplaceEditorCommand = ViewCommand | CreateCommand | StrReplaceCommand | InsertCommand | UndoEditCommand

Classes