# Pydantic Deep Agents

> Build Claude Code-Style AI Agents in Python

## Getting Started

- [Pydantic Deep Agents](https://vstorm-co.github.io/pydantic-deepagents/index.md): Project overview and quick start
- [Installation](https://vstorm-co.github.io/pydantic-deepagents/installation/index.md): Installation instructions
- [Getting Help](https://vstorm-co.github.io/pydantic-deepagents/getting-help/index.md): How to get help

## Tutorial

- [Tutorial — User Guide](https://vstorm-co.github.io/pydantic-deepagents/learn/index.md): Tutorial overview
- [Your first agent](https://vstorm-co.github.io/pydantic-deepagents/learn/first-agent/index.md): Your first agent
- [Files & the shell](https://vstorm-co.github.io/pydantic-deepagents/learn/files-and-shell/index.md): Files and the shell
- [Planning with todos](https://vstorm-co.github.io/pydantic-deepagents/learn/planning/index.md): Planning with todos
- [Custom tools](https://vstorm-co.github.io/pydantic-deepagents/learn/custom-tools/index.md): Custom tools
- [Skills](https://vstorm-co.github.io/pydantic-deepagents/learn/skills/index.md): Skills
- [Subagents](https://vstorm-co.github.io/pydantic-deepagents/learn/subagents/index.md): Subagents
- [Structured output](https://vstorm-co.github.io/pydantic-deepagents/learn/structured-output/index.md): Structured output
- [Streaming](https://vstorm-co.github.io/pydantic-deepagents/learn/streaming/index.md): Streaming
- [Human-in-the-loop](https://vstorm-co.github.io/pydantic-deepagents/learn/human-in-the-loop/index.md): Human-in-the-loop
- [Memory & context files](https://vstorm-co.github.io/pydantic-deepagents/learn/memory/index.md): Memory and context files
- [Sessions & checkpoints](https://vstorm-co.github.io/pydantic-deepagents/learn/sessions/index.md): Sessions and checkpoints
- [Web search & MCP](https://vstorm-co.github.io/pydantic-deepagents/learn/web-and-mcp/index.md): Web search and MCP

## Core Concepts

- [Core Concepts](https://vstorm-co.github.io/pydantic-deepagents/concepts/index.md): Core concepts overview
- [Agents](https://vstorm-co.github.io/pydantic-deepagents/concepts/agents/index.md): Agent creation and configuration
- [Backends](https://vstorm-co.github.io/pydantic-deepagents/concepts/backends/index.md): Backend abstraction for file operations
- [Toolsets](https://vstorm-co.github.io/pydantic-deepagents/concepts/toolsets/index.md): Available toolsets and custom tools
- [Skills](https://vstorm-co.github.io/pydantic-deepagents/concepts/skills/index.md): Skills system

## Advanced

- [Advanced User Guide](https://vstorm-co.github.io/pydantic-deepagents/advanced/index.md): Advanced guide overview
- [Capabilities & lifecycle](https://vstorm-co.github.io/pydantic-deepagents/advanced/capabilities/index.md): Capabilities and the lifecycle
- [Hooks](https://vstorm-co.github.io/pydantic-deepagents/advanced/hooks/index.md): Claude Code-style lifecycle hooks
- [Context management](https://vstorm-co.github.io/pydantic-deepagents/advanced/context-management/index.md): Context management (summarization and eviction)
- [Cost tracking & budgets](https://vstorm-co.github.io/pydantic-deepagents/advanced/cost-tracking/index.md): Token and cost tracking
- [Stuck-loop detection](https://vstorm-co.github.io/pydantic-deepagents/advanced/stuck-loop-detection/index.md): Stuck loop detection
- [Periodic reminders](https://vstorm-co.github.io/pydantic-deepagents/advanced/periodic-reminder/index.md): Periodic task reminder
- [Goal loop](https://vstorm-co.github.io/pydantic-deepagents/advanced/goal/index.md): Goal completion loop
- [Monitor (watch & react)](https://vstorm-co.github.io/pydantic-deepagents/advanced/monitor/index.md): Monitor (watch and react)
- [Message queue (steering)](https://vstorm-co.github.io/pydantic-deepagents/advanced/message-queue/index.md): Message queue (steering and follow-up)
- [Live Run Forking](https://vstorm-co.github.io/pydantic-deepagents/advanced/forking/index.md): Live Run Forking (parallel agent branches)
- [Agent teams](https://vstorm-co.github.io/pydantic-deepagents/advanced/teams/index.md): Agent teams with shared todos
- [Output styles](https://vstorm-co.github.io/pydantic-deepagents/advanced/output-styles/index.md): Output style customization
- [Fallback models](https://vstorm-co.github.io/pydantic-deepagents/advanced/fallback-models/index.md): Automatic fallback models
- [Plan mode](https://vstorm-co.github.io/pydantic-deepagents/advanced/plan-mode/index.md): Plan mode subagent
- [Browser](https://vstorm-co.github.io/pydantic-deepagents/advanced/browser/index.md): Browser automation via Playwright
- [Document parsing](https://vstorm-co.github.io/pydantic-deepagents/advanced/liteparse/index.md): Document parsing (LiteParse)
- [Agent Spec](https://vstorm-co.github.io/pydantic-deepagents/advanced/agent-spec/index.md): Agent spec (YAML/JSON)
- [Multi-user](https://vstorm-co.github.io/pydantic-deepagents/advanced/multi-user/index.md): Multi-user isolation patterns

## CLI

- [CLI — the terminal assistant](https://vstorm-co.github.io/pydantic-deepagents/cli/index.md): CLI overview
- [Install & first run](https://vstorm-co.github.io/pydantic-deepagents/cli/getting-started/index.md): CLI install and first run
- [Commands](https://vstorm-co.github.io/pydantic-deepagents/cli/commands/index.md): CLI slash commands
- [Keys & input](https://vstorm-co.github.io/pydantic-deepagents/cli/keybindings/index.md): CLI keys and input
- [Settings & themes](https://vstorm-co.github.io/pydantic-deepagents/cli/settings/index.md): CLI settings and themes
- [Sessions, forking & MCP](https://vstorm-co.github.io/pydantic-deepagents/cli/sessions-forking-mcp/index.md): CLI sessions, forking, and MCP

## Applications

- [Applications](https://vstorm-co.github.io/pydantic-deepagents/apps/index.md): Reference applications overview
- [DeepResearch](https://vstorm-co.github.io/pydantic-deepagents/apps/deepresearch/index.md): DeepResearch app
- [ACP adapter (Zed)](https://vstorm-co.github.io/pydantic-deepagents/apps/acp/index.md): ACP editor integration (Zed)
- [Harbor (Terminal Bench)](https://vstorm-co.github.io/pydantic-deepagents/apps/harbor/index.md): Harbor (Terminal Bench)

## Examples

- [Examples](https://vstorm-co.github.io/pydantic-deepagents/examples/index.md)
- [Basic Usage](https://vstorm-co.github.io/pydantic-deepagents/examples/basic-usage/index.md)
- [Composite Backend Example](https://vstorm-co.github.io/pydantic-deepagents/examples/composite-backend/index.md)
- [Custom Tools Example](https://vstorm-co.github.io/pydantic-deepagents/examples/custom-tools/index.md)
- [Docker Runtimes](https://vstorm-co.github.io/pydantic-deepagents/examples/docker-runtimes/index.md)
- [Docker Sandbox Example](https://vstorm-co.github.io/pydantic-deepagents/examples/docker-sandbox/index.md)
- [File Uploads](https://vstorm-co.github.io/pydantic-deepagents/examples/file-uploads/index.md)
- [Filesystem Example](https://vstorm-co.github.io/pydantic-deepagents/examples/filesystem/index.md)
- [Full Application Example](https://vstorm-co.github.io/pydantic-deepagents/examples/full-app/index.md)
- [Human-in-the-Loop Example](https://vstorm-co.github.io/pydantic-deepagents/examples/human-in-the-loop/index.md)
- [Interactive Chat Example](https://vstorm-co.github.io/pydantic-deepagents/examples/interactive-chat/index.md)
- [MCP Server Example](https://vstorm-co.github.io/pydantic-deepagents/examples/mcp/index.md)
- [Skills Example](https://vstorm-co.github.io/pydantic-deepagents/examples/skills/index.md)
- [Streaming Example](https://vstorm-co.github.io/pydantic-deepagents/examples/streaming/index.md)
- [Subagents Example](https://vstorm-co.github.io/pydantic-deepagents/examples/subagents/index.md)
- [Thinking Example](https://vstorm-co.github.io/pydantic-deepagents/examples/thinking/index.md)
- [Web Tools Example](https://vstorm-co.github.io/pydantic-deepagents/examples/web-tools/index.md)

## API Reference

- [Agent](https://vstorm-co.github.io/pydantic-deepagents/api/agent/index.md): Agent factory API
- [Backends](https://vstorm-co.github.io/pydantic-deepagents/api/backends/index.md): Backend API
- [Toolsets](https://vstorm-co.github.io/pydantic-deepagents/api/toolsets/index.md): Toolset API
- [Capabilities](https://vstorm-co.github.io/pydantic-deepagents/api/capabilities/index.md): Capabilities API
- [Processors](https://vstorm-co.github.io/pydantic-deepagents/api/processors/index.md): Processor API
- [MCP](https://vstorm-co.github.io/pydantic-deepagents/api/mcp/index.md): MCP client API
- [Forking](https://vstorm-co.github.io/pydantic-deepagents/api/forking/index.md): Live Run Forking API
- [Checkpointing](https://vstorm-co.github.io/pydantic-deepagents/api/checkpointing/index.md): Checkpointing API
- [Teams](https://vstorm-co.github.io/pydantic-deepagents/api/teams/index.md): Teams API
- [Memory](https://vstorm-co.github.io/pydantic-deepagents/api/memory/index.md): Memory API
- [Context Files](https://vstorm-co.github.io/pydantic-deepagents/api/context-files/index.md): Context Files API
- [Output Styles](https://vstorm-co.github.io/pydantic-deepagents/api/output-styles/index.md): Output Styles API
- [Hooks](https://vstorm-co.github.io/pydantic-deepagents/api/hooks/index.md): Hooks API
- [Monitoring](https://vstorm-co.github.io/pydantic-deepagents/api/monitoring/index.md): Monitoring API
- [Goal](https://vstorm-co.github.io/pydantic-deepagents/api/goal/index.md): Goal API
- [Tool Search](https://vstorm-co.github.io/pydantic-deepagents/api/tool-search/index.md): Tool Search API
- [Message Queue](https://vstorm-co.github.io/pydantic-deepagents/api/message-queue/index.md): Message Queue API
- [Agent Spec](https://vstorm-co.github.io/pydantic-deepagents/api/spec/index.md): Agent spec (YAML/JSON) API
- [Types](https://vstorm-co.github.io/pydantic-deepagents/api/types/index.md): Type definitions