Reference Docs

Quick lookup tables for tools, SDK options, message types, and other key concepts. Click on any tool name for detailed information.

Built-In Tools Catalog

ToolCategoryPurpose
ReadFile I/ORead file contents
WriteFile I/OCreate new files
EditFile I/OModify files precisely
BashExecutionRun shell commands, git, scripts
MonitorExecutionWatch background process output
GlobSearchFind files by pattern (e.g., src/**/*.py)
GrepSearchSearch file contents with regex
WebSearchWebSearch the internet
WebFetchWebFetch and parse web pages
AskUserQuestionInputPrompt user with multiple choice
AgentOrchestrationSpawn subagents
SkillOrchestrationCall custom skills

ClaudeAgentOptions Fields

OptionTypeDefaultPurpose
allowed_toolslist[str]NonePre-approve tools (no permission prompt)
disallowed_toolslist[str]NoneBlock specific tools
max_turnsint∞Max iterations before stopping
max_budget_usdfloatNoneStop if cost exceeds limit
effortstrhighReasoning depth: low/medium/high/xhigh/max
modelstrsonnetModel to use (opus, sonnet, haiku)
permission_modestrdefaultHow to handle unlisted tools
resumestrNoneResume previous session by ID

Permission Modes

default

Ask user for permission on tools not in allowed_tools

dontAsk

Deny permission automatically (no prompt)

acceptEdits

Auto-approve file edits (Read/Write/Edit only)

plan

Show plan before executing edits

bypassPermissions

Auto-approve all tools (use with caution!)

Message Types

SystemMessage
init

Session started with metadata and session ID

AssistantMessage

Claude decided to use tools or respond

UserMessage

Tool results being sent back to Claude

ResultMessage
success/error_*

Final completion with result or error code

10 Excellent Use Cases for Claude Code Agents

Discover powerful ways to apply Claude Code agents to automate your development workflow. Click on any use case for detailed information.

👁️
#1

Automated Code Review

Click to see benefits, tools, and examples

🐛
#2

Bug Detection & Fixing

Click to see benefits, tools, and examples

✅
#3

Test Automation

Click to see benefits, tools, and examples

📚
#4

Documentation Generation

Click to see benefits, tools, and examples

⚡
#5

Performance Optimization

Click to see benefits, tools, and examples

🗄️
#6

Database Migrations

Click to see benefits, tools, and examples

🔌
#7

API Generation

Click to see benefits, tools, and examples

🔒
#8

Security Scanning

Click to see benefits, tools, and examples

📊
#9

Log Analysis

Click to see benefits, tools, and examples

🚀
#10

Build & Deployment

Click to see benefits, tools, and examples