Skip to main content

Module tool

Module tool 

Source

Modules§

auto_fix
Pre-write validation and auto-fix for edited content.
bash
blast_radius
cd
diagnostics
Diagnostics tool — surfaces real-time compiler/linter diagnostics from the Language Server without running a full build.
edit
file_deps
file_history
File-level snapshot history — backup files before every edit/write.
find_references
glob
grep
list_dir
list_symbols
open_file
open_file tool — launch a local file in the user’s default GUI application (browser for HTML, viewer for PDF / image / SVG, etc.).
parallel_edit
Active-dispatch fork sub-agent tool.
read
read_symbol
result_store
search_replace
todo
TodoWrite tool — lets the agent track tasks during a session.
trace_callees
trace_callers
trace_chain
use_skill
web_fetch
web_search
write

Structs§

PermissionStore
Stores per-tool permission overrides and session-level grants.
ResolvedPath
ToolCall
ToolCallBuffer
ToolContext
Holds a shared working directory that tools can read (and CdTool can write).
ToolDef
ToolRegistry
ToolResult

Enums§

ApprovalRequirement
ExternalPathAction
PermissionDecision
The resolved decision returned by PermissionStore::check.
PermissionLevel
Coarse-grained permission level for a tool, stored in PermissionStore.

Constants§

SKIP_DIRS
Directories to skip when scanning file trees (build artifacts, caches, VCS). Used by glob, list_dir, and collect_project_files.
SKIP_DIR_PREFIXES
Prefixes — any directory whose name starts with one of these is skipped. Covers .venv-* variants (.venv-test, .venv-swebench, etc.).

Traits§

Tool

Functions§

approval_for_path
diagnose_args
Model-friendly tool-arguments validator.
extract_error_signatures
Extract up to 5 distinctive diagnostic lines from a failed bash/tool output for use as a multi-signature “error anchor” (P0 #5). Selection rule: longest lines first. Rationale — status noise (Checking v0.1.0 (/path), Blocking waiting for file lock) is almost always shorter than real diagnostic content (error[E0425]: cannot find function \foo` in this scope`, full compiler traces). Sorting by length pushes ambient status to the back of the queue without hardcoding tool names.
inspect_path_access
real_home_dir
Get the real user’s home directory, accounting for sudo scenarios.
recover_tool_args
Recover a flat schema-shaped JSON object from possibly-mangled tool args.
resolve_workspace_path
shared_prefix_len
Count of leading characters shared between two paths. Used by read_file and glob 404 recovery to rank candidate suggestions.
should_skip_dir
Check if a directory name should be skipped (exact match OR prefix match). Use this instead of SKIP_DIRS.contains() for complete coverage.

Type Aliases§

ReadCacheEntry
Read cache entry: (file mtime at cache time, rendered tool output, number of times this exact (path, offset, limit, mtime) tuple has been served).
ReadCacheKey
Shared execution context passed to every tool invocation. Read cache key: (canonical path, offset, limit). offset/limit are the raw args the model sent — different slicing windows cache separately.