Skip to main content

Module builtin

Module builtin 

Source
Expand description

Built-in tools: shell, file read/write/edit, glob, grep.

Each tool gates write access through PermissionDecision::Ask so the host (typically a human approval prompt) keeps the final say. Read-only tools are marked concurrency-safe so they can run in parallel batches.

Structs§

AskUserQuestionTool
Tool that presents structured questions to the user.
BrowserBackTool
BrowserClickTool
BrowserCloseTool
BrowserFindUrlTool
BrowserManager
BrowserNavigateTool
BrowserScreenshotTool
BrowserScrollTool
BrowserSelectTool
BrowserStartTool
BrowserStateTool
BrowserTypeTool
CodeContextTool
CodeIndexRefreshTool
CodeSearchTool
EnterPlanModeTool
EnterPlanMode — switch to read-only exploration/design mode.
ExitPlanModeTool
ExitPlanMode — read the plan file and submit it.
FileEditTool
Built-in file-edit tool. Performs a single, unambiguous string replacement.
FileReadTool
Built-in file-read tool. Read-only; safe to run concurrently.
FileWriteTool
Built-in file-write tool. Writes (and creates) text files inside the workspace.
GlobTool
Built-in glob tool. Read-only; safe to run concurrently.
GrepTool
Built-in grep tool. Read-only; safe to run concurrently.
MemoryEditTool
MemoryGrepTool
MemoryMaintenanceTool
MemoryReadTool
MemoryStatusTool
MemoryWriteTool
PowerShellTool
PythonScriptTool
SendUserMessageTool
SendUserMessage — send a message (with optional attachments) to the user.
ShellTool
Built-in shell tool. Spawns bash -c <command> inside the workspace.
SkillTool
Tool that lets the model invoke a user-defined skill by name. The skill’s prompt (with {{args}} substituted) is returned to the model.
TaskCreateTool
TaskGetTool
TaskListTool
TaskOutputTool
TaskStopTool
TaskUpdateTool
TeamCreateTool
TeamCreate — initialize a new collaboration team.
TeamDeleteTool
TeamDelete — tear down the current team.
TodoWriteTool
TodoWrite — replace the todo list with the given items.
WebFetchTool
Tool that fetches a URL and returns its content as plain text.
WebSearchTool
Tool that searches the web without an API key.

Enums§

DefaultShell
Default shell exposed to the model for shell-style commands.

Functions§

register_core_tools
Register every built-in tool with the current platform’s default shell.
register_core_tools_with_shell
Register every built-in tool with an explicit default shell.
register_memory_tools
Register memory tools with the supplied registry.
register_skill_tool
Register the Skill tool if a skill registry is available.
register_task_tools
Register task tracking tools with the supplied registry.