Tool Reference

注意

This reference covers all 46 built-in tools available in Claude Code. Tools are organized by category. Each entry includes the tool name, input parameters, output format, and a brief description. Parameter types follow Zod schema conventions.

File Operations

Read

Field	Value
Name	Read
Category	File Operations
Description	Read a file from the local filesystem. Supports text files, images (PNG, JPG), PDFs, and Jupyter notebooks (.ipynb).

Input Parameters:

Parameter	Type	Required	Description
file_path	string	✅	Absolute path to the file to read
offset	number	❌	Line number to start reading from (1-indexed)
limit	number	❌	Maximum number of lines to read

Output: File content with line numbers (cat -n format). Images are rendered visually. PDFs are processed page by page.

---

Edit

Field	Value
Name	Edit
Category	File Operations
Description	Perform exact string replacements in files. Requires prior Read of the file.

Input Parameters:

Parameter	Type	Required	Description
file_path	string	✅	Absolute path to the file to modify
old_string	string	✅	The exact text to replace (must be unique in the file)
new_string	string	✅	The replacement text
replace_all	boolean	❌	Replace all occurrences (default: false)

Output: Confirmation of the edit with surrounding context.

---

Write

Field	Value
Name	Write
Category	File Operations
Description	Write (overwrite) a file on the local filesystem. Requires prior Read if file exists.

Input Parameters:

Parameter	Type	Required	Description
file_path	string	✅	Absolute path to the file to write
content	string	✅	The complete content to write

Output: Confirmation that the file was written successfully.

---

NotebookEdit

Field	Value
Name	NotebookEdit
Category	File Operations
Description	Create, replace, or delete cells in Jupyter notebooks (.ipynb files).

Input Parameters:

Parameter	Type	Required	Description
notebook_path	string	✅	Absolute path to the notebook file
new_source	string	✅	New source content for the cell
cell_id	string	❌	ID of the cell to edit or insert after
cell_type	"code" | "markdown"	❌	Cell type (required for insert)
edit_mode	"replace" | "insert" | "delete"	❌	Type of edit (default: replace)

Output: Confirmation of the notebook modification.

Search & Navigation

Glob

Field	Value
Name	Glob
Category	Search & Navigation
Description	Fast file pattern matching. Returns matching file paths sorted by modification time.

Input Parameters:

Parameter	Type	Required	Description
pattern	string	✅	Glob pattern to match (e.g., **/*.ts, src/**/*.tsx)
path	string	❌	Directory to search in (default: cwd)

Output: List of matching file paths, sorted by modification time.

---

Grep

Field	Value
Name	Grep
Category	Search & Navigation
Description	Search file contents using regular expressions. Built on ripgrep.

Input Parameters:

Parameter	Type	Required	Description
pattern	string	✅	Regex pattern to search for
path	string	❌	File or directory to search (default: cwd)
output_mode	"content" | "files_with_matches" | "count"	❌	Output format (default: files_with_matches)
glob	string	❌	File glob filter (e.g., *.ts)
type	string	❌	File type filter (e.g., js, py)
-i	boolean	❌	Case-insensitive search
-n	boolean	❌	Show line numbers (default: true)
-A	number	❌	Lines after match
-B	number	❌	Lines before match
-C	number	❌	Lines around match (context)
multiline	boolean	❌	Enable multiline matching
head_limit	number	❌	Limit output to first N entries
offset	number	❌	Skip first N entries

Output: Matching content, file paths, or counts depending on output_mode.

Shell Execution

Bash

Field	Value
Name	Bash
Category	Shell Execution
Description	Execute bash commands in a persistent shell session. Subject to 27-layer security checks.

Input Parameters:

Parameter	Type	Required	Description
command	string	✅	The bash command to execute
description	string	❌	Brief description of command purpose
timeout	number	❌	Timeout in ms (max: 600,000, default: 120,000)
run_in_background	boolean	❌	Run in background, notify on completion
dangerouslyDisableSandbox	boolean	❌	Disable sandbox mode (requires explicit flag)

Output: Command stdout and stderr. Truncated if exceeding 30,000 characters.

Web & Network

WebSearch

Field	Value
Name	WebSearch
Category	Web & Network
Description	Search the web for current information. Returns search results with titles, URLs, and snippets.

Input Parameters:

Parameter	Type	Required	Description
query	string	✅	Search query (min 2 characters)
allowed_domains	string[]	❌	Only include results from these domains
blocked_domains	string[]	❌	Exclude results from these domains

Output: Search results with titles, URLs, and content snippets.

---

WebFetch

Field	Value
Name	WebFetch
Category	Web & Network
Description	Fetch a URL and process its content. Converts HTML to markdown for analysis.

Input Parameters:

Parameter	Type	Required	Description
url	string (URI)	✅	Fully-formed URL to fetch
prompt	string	✅	Prompt describing what to extract from the page

Output: Processed content based on the prompt. Large content may be summarized.

Task Management

TodoWrite

Field	Value
Name	TodoWrite
Category	Task Management
Description	Create and manage a structured task list for tracking progress on complex operations.

Input Parameters:

Parameter	Type	Required	Description
todos	TodoItem[]	✅	Complete updated todo list

TodoItem Schema:

Field	Type	Required	Description
content	string	✅	Task description in imperative form (e.g., “Fix bug”)
activeForm	string	✅	Present continuous form (e.g., “Fixing bug”)
status	"pending" | "in_progress" | "completed"	✅	Current task state

Output: Confirmation of todo list update.

Version Control

GitStatus

Field	Value
Name	GitStatus
Category	Version Control
Description	Show working tree status: staged, unstaged, and untracked files.

Input Parameters: None

Output: Git status output showing file states.

---

GitDiff

Field	Value
Name	GitDiff
Category	Version Control
Description	Show changes between commits, working tree, and staging area.

Input Parameters:

Parameter	Type	Required	Description
args	string	❌	Arguments to pass to git diff (e.g., --staged, HEAD~1)

Output: Unified diff output.

---

GitLog

Field	Value
Name	GitLog
Category	Version Control
Description	Show commit log history.

Input Parameters:

Parameter	Type	Required	Description
args	string	❌	Arguments to pass to git log (e.g., -n 10, --oneline)

Output: Formatted commit log.

---

GitCommit

Field	Value
Name	GitCommit
Category	Version Control
Description	Create a git commit with staged changes.

Input Parameters:

Parameter	Type	Required	Description
message	string	✅	Commit message

Output: Commit hash and summary.

Agent Management

Skill

Field	Value
Name	Skill
Category	Agent Management
Description	Execute a predefined skill (workflow template) within the conversation.

Input Parameters:

Parameter	Type	Required	Description
skill	string	✅	Skill name (e.g., “commit”, “review-pr”, “pdf”)
args	string	❌	Optional arguments for the skill

Output: Skill execution output (varies by skill).

---

Fork

Field	Value
Name	Fork
Category	Agent Management
Description	Spawn an independent sub-agent for a parallel subtask. Shares the parent’s prompt cache prefix.

Input Parameters:

Parameter	Type	Required	Description
task	string	✅	Task description for the sub-agent
context	string	❌	Additional context beyond shared prefix
maxTurns	number	❌	Maximum turns for the sub-agent (default: 10)

Output: Sub-agent’s final result.

---

Coordinator

Field	Value
Name	Coordinator
Category	Agent Management
Description	Launch a coordinator agent that plans and manages a multi-step workflow with worker agents.

Input Parameters:

Parameter	Type	Required	Description
goal	string	✅	High-level goal to accomplish
maxWorkers	number	❌	Maximum concurrent workers (default: 3)
maxRounds	number	❌	Maximum coordination rounds (default: 20)

Output: Synthesized result from all worker outputs.

MCP Tools

MCPTool (Dynamic)

Field	Value
Name	Varies (provided by MCP server)
Category	MCP
Description	Tools dynamically discovered from connected MCP servers. Schema defined by the MCP server.

Input Parameters: Defined by the MCP server’s tool schema.

Output: Defined by the MCP server’s tool response.

注意

MCP tools are not hard-coded in Claude Code. They are dynamically discovered at startup from configured MCP servers. Each MCP tool’s name, description, and schema come from the server, and Claude Code adapts its tool registry accordingly.

Additional Built-in Tools

The following tools complete the set of 46 built-in tools:

File Operations (Extended)

Tool	Description
ListDirectory	List files and directories at a path with metadata
FileInfo	Get file metadata: size, permissions, modification time
Move	Move or rename a file or directory
Copy	Copy a file or directory

Search (Extended)

Tool	Description
FindReferences	Find all references to a symbol in the codebase
GoToDefinition	Navigate to the definition of a symbol
ListSymbols	List all symbols (functions, classes, types) in a file

Git (Extended)

Tool	Description
GitAdd	Stage files for commit
GitBranch	List, create, or delete branches
GitCheckout	Switch branches or restore files
GitStash	Stash working directory changes
GitBlame	Show line-by-line authorship
GitShow	Show commit details or file at a specific revision

System & Environment

Tool	Description
GetWorkingDirectory	Return the current working directory
GetEnvironment	Return environment information (OS, shell, runtime)
ReadImage	Read and analyze an image file
ReadPDF	Read and extract content from a PDF file

Agent & Workflow

Tool	Description
TeamSwarm	Launch a team of peer agents with shared mailbox
DreamTask	Queue a speculative background task
TaskOutput	Read output from a background task
MemoryWrite	Persist information to long-term memory
MemoryRead	Retrieve information from long-term memory

Tool Category Summary

Category	Count	Permission Level
File Operations	7	Write operations need approval; reads auto-approved
Search & Navigation	5	Auto-approved (read-only)
Shell Execution	1	27-layer security check
Web & Network	2	Auto-approved
Task Management	1	Auto-approved
Version Control	8	Read operations auto-approved; writes need approval
Agent Management	4	Auto-approved (delegated to sub-agents)
MCP	Dynamic	Follows MCP server configuration
System & Environment	4	Auto-approved (read-only)
Agent & Workflow	5	Auto-approved
Total	~46	—