Back to Deepagents

README

examples/README.md

latest2.0 KB
Original Source
<p align="center"> <picture> <source media="(prefers-color-scheme: light)" srcset="../.github/images/logo-light.svg"> <source media="(prefers-color-scheme: dark)" srcset="../.github/images/logo-dark.svg"> </picture> </p> <h3 align="center">Examples</h3> <p align="center"> Agents, patterns, and applications you can build with Deep Agents. </p>
ExampleDescription
deep_researchMulti-step web research agent using Tavily for URL discovery, parallel sub-agents, and strategic reflection
content-builder-agentContent writing agent that demonstrates memory (AGENTS.md), skills, and subagents for blog posts, LinkedIn posts, and tweets with generated images
text-to-sql-agentNatural language to SQL agent with planning, skill-based workflows, and the Chinook demo database
ralph_modeAutonomous looping pattern that runs with fresh context each iteration, using the filesystem for persistence
downloading_agentsShows how agents are just folders—download a zip, unzip, and run

Each example has its own README with setup instructions.

Contributing an Example

See the Contributing Guide for general contribution guidelines.

When adding a new example:

  • Use uv for dependency management with a pyproject.toml and uv.lock (commit the lock file)
  • Pin to deepagents version — use a version range (e.g., >=0.3.5,<0.4.0) in dependencies
  • Include a README with clear setup and usage instructions
  • Add tests for reusable utilities or non-trivial helper logic
  • Keep it focused — each example should demonstrate one use-case or workflow
  • Follow the structure of existing examples (see deep_research/ or text-to-sql-agent/ as references)