README.md

# Agent Development Kit (ADK)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
[![PyPI](https://img.shields.io/pypi/v/google-adk)](https://pypi.org/project/google-adk/)
[![Python Unit Tests](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml/badge.svg)](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml)
[![r/agentdevelopmentkit](https://img.shields.io/badge/Reddit-r%2Fagentdevelopmentkit-FF4500?style=flat&logo=reddit&logoColor=white)](https://www.reddit.com/r/agentdevelopmentkit/)
<a href="https://codewiki.google/github.com/google/adk-python"><img src="https://www.gstatic.com/_/boq-sdlc-agents-ui/_/r/Mvosg4klCA4.svg" alt="Ask Code Wiki" height="20"></a>

<html>
    <h2 align="center">
      <img src="https://raw.githubusercontent.com/google/adk-python/main/assets/agent-development-kit.png" width="256"/>
    </h2>
    <h3 align="center">
      An open-source, code-first Python framework for building, evaluating, and deploying sophisticated AI agents with flexibility and control.
    </h3>
    <h3 align="center">
      Important Links:
      <a href="https://google.github.io/adk-docs/">Docs</a>,
      <a href="https://github.com/google/adk-samples">Samples</a>,
      <a href="https://github.com/google/adk-java">Java ADK</a>,
      <a href="https://github.com/google/adk-go">Go ADK</a> &
      <a href="https://github.com/google/adk-web">ADK Web</a>.
    </h3>
</html>

Agent Development Kit (ADK) is a flexible and modular framework that applies
software development principles to AI agent creation. It is designed to
simplify building, deploying, and orchestrating agent workflows, from simple
tasks to complex systems. While optimized for Gemini, ADK is model-agnostic,
deployment-agnostic, and compatible with other frameworks.

---

## 🔥 What's new

- **Custom Service Registration**: Add a service registry to provide a generic way to register custom service implementations to be used in FastAPI server. See [short instruction](https://github.com/google/adk-python/discussions/3175#discussioncomment-14745120). ([391628f](https://github.com/google/adk-python/commit/391628fcdc7b950c6835f64ae3ccab197163c990))

- **Rewind**: Add the ability to rewind a session to before a previous invocation ([9dce06f](https://github.com/google/adk-python/commit/9dce06f9b00259ec42241df4f6638955e783a9d1)).

- **New CodeExecutor**: Introduces a new AgentEngineSandboxCodeExecutor class that supports executing agent-generated code using the Vertex AI Code Execution Sandbox API ([ee39a89](https://github.com/google/adk-python/commit/ee39a891106316b790621795b5cc529e89815a98))

## ✨ Key Features

- **Rich Tool Ecosystem**: Utilize pre-built tools, custom functions,
  OpenAPI specs, MCP tools or integrate existing tools to give agents diverse
  capabilities, all for tight integration with the Google ecosystem.

- **Code-First Development**: Define agent logic, tools, and orchestration
  directly in Python for ultimate flexibility, testability, and versioning.

- **Agent Config**: Build agents without code. Check out the
  [Agent Config](https://google.github.io/adk-docs/agents/config/) feature.

- **Tool Confirmation**: A [tool confirmation flow(HITL)](https://google.github.io/adk-docs/tools/confirmation/) that can guard tool execution with explicit confirmation and custom input.

- **Modular Multi-Agent Systems**: Design scalable applications by composing
  multiple specialized agents into flexible hierarchies.

- **Deploy Anywhere**: Easily containerize and deploy agents on Cloud Run or
  scale seamlessly with Vertex AI Agent Engine.

## 🚀 Installation

### Stable Release (Recommended)

You can install the latest stable version of ADK using `pip`:

```bash
pip install google-adk
```

The release cadence is roughly bi-weekly.

This version is recommended for most users as it represents the most recent official release.

### Development Version
Bug fixes and new features are merged into the main branch on GitHub first. If you need access to changes that haven't been included in an official PyPI release yet, you can install directly from the main branch:

```bash
pip install git+https://github.com/google/adk-python.git@main
```

Note: The development version is built directly from the latest code commits. While it includes the newest fixes and features, it may also contain experimental changes or bugs not present in the stable release. Use it primarily for testing upcoming changes or accessing critical fixes before they are officially released.

## 🤖 Agent2Agent (A2A) Protocol and ADK Integration

For remote agent-to-agent communication, ADK integrates with the
[A2A protocol](https://github.com/google-a2a/A2A/).
See this [example](https://github.com/a2aproject/a2a-samples/tree/main/samples/python/agents)
for how they can work together.

## 📚 Documentation

Explore the full documentation for detailed guides on building, evaluating, and
deploying agents:

* **[Documentation](https://google.github.io/adk-docs)**

## 🏁 Feature Highlight

### Define a single agent:

```python
from google.adk.agents import Agent
from google.adk.tools import google_search

root_agent = Agent(
    name="search_assistant",
    model="gemini-2.5-flash", # Or your preferred Gemini model
    instruction="You are a helpful assistant. Answer user questions using Google Search when needed.",
    description="An assistant that can search the web.",
    tools=[google_search]
)
```

### Define a multi-agent system:

Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents works together to accomplish the task.

```python
from google.adk.agents import LlmAgent, BaseAgent

# Define individual agents
greeter = LlmAgent(name="greeter", model="gemini-2.5-flash", ...)
task_executor = LlmAgent(name="task_executor", model="gemini-2.5-flash", ...)

# Create parent agent and assign children via sub_agents
coordinator = LlmAgent(
    name="Coordinator",
    model="gemini-2.5-flash",
    description="I coordinate greetings and tasks.",
    sub_agents=[ # Assign sub_agents here
        greeter,
        task_executor
    ]
)
```

### Development UI

A built-in development UI to help you test, evaluate, debug, and showcase your agent(s).

<img src="https://raw.githubusercontent.com/google/adk-python/main/assets/adk-web-dev-ui-function-call.png"/>

###  Evaluate Agents

```bash
adk eval \
    samples_for_testing/hello_world \
    samples_for_testing/hello_world/hello_world_eval_set_001.evalset.json
```

## 🤝 Contributing

We welcome contributions from the community! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our
- [General contribution guideline and flow](https://google.github.io/adk-docs/contributing-guide/).
- Then if you want to contribute code, please read [Code Contributing Guidelines](./CONTRIBUTING.md) to get started.

## Community Repo

We have [adk-python-community repo](https://github.com/google/adk-python-community)that is home to a growing ecosystem of community-contributed tools, third-party
service integrations, and deployment scripts that extend the core capabilities
of the ADK.

## Vibe Coding

If you are to develop agent via vibe coding the [llms.txt](./llms.txt) and the [llms-full.txt](./llms-full.txt) can be used as context to LLM. While the former one is a summarized one and the later one has the full information in case your LLM has big enough context window.

## Community Events

- [Completed] ADK's 1st community meeting on Wednesday, October 15, 2025. Remember to [join our group](https://groups.google.com/g/adk-community) to get access to the [recording](https://drive.google.com/file/d/1rpXDq5NSH8-MyMeYI6_5pZ3Lhn0X9BQf/view), and [deck](https://docs.google.com/presentation/d/1_b8LG4xaiadbUUDzyNiapSFyxanc9ZgFdw7JQ6zmZ9Q/edit?slide=id.g384e60cdaca_0_658&resourcekey=0-tjFFv0VBQhpXBPCkZr0NOg#slide=id.g384e60cdaca_0_658).

## 📄 License

This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.

---

*Happy Agent Building!*
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			`# Agent Development Kit (ADK)`
first commit 2025-04-02 20:17:46 +00:00
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			`[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)`
docs: Adds pypi badge to README.md 2025-08-11 10:47:18 -07:00			`[![PyPI](https://img.shields.io/pypi/v/google-adk)](https://pypi.org/project/google-adk/)`
Update README.md (#126 ) 2025-04-12 21:00:57 -07:00			`[![Python Unit Tests](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml/badge.svg)](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml)`
chore: Add subreddit README badge (#122 ) 2025-04-12 09:51:09 -07:00			`[![r/agentdevelopmentkit](https://img.shields.io/badge/Reddit-r%2Fagentdevelopmentkit-FF4500?style=flat&logo=reddit&logoColor=white)](https://www.reddit.com/r/agentdevelopmentkit/)`
docs: Add Code Wiki badge to README 2025-11-20 09:59:52 -08:00			`<a href="https://codewiki.google/github.com/google/adk-python"><img src="https://www.gstatic.com/_/boq-sdlc-agents-ui/_/r/Mvosg4klCA4.svg" alt="Ask Code Wiki" height="20"></a>`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00
Changes for 0.1.0 release 2025-04-09 04:24:34 +00:00			`<html>`
No public description 2025-04-17 19:50:22 +00:00			`<h2 align="center">`
			`<img src="https://raw.githubusercontent.com/google/adk-python/main/assets/agent-development-kit.png" width="256"/>`
			`</h2>`
Changes for 0.1.0 release 2025-04-09 04:24:34 +00:00			`<h3 align="center">`
chore: Revise README for clarity and consistency 2025-10-30 11:02:00 -07:00			`An open-source, code-first Python framework for building, evaluating, and deploying sophisticated AI agents with flexibility and control.`
Changes for 0.1.0 release 2025-04-09 04:24:34 +00:00			`</h3>`
			`<h3 align="center">`
			`Important Links:`
docs: Adds pypi badge to README.md 2025-08-11 10:47:18 -07:00			`<a href="https://google.github.io/adk-docs/">Docs</a>,`
Copybara import of the project: 2025-05-23 16:09:52 -07:00			`<a href="https://github.com/google/adk-samples">Samples</a>,`
chore: Add Go ADK link to README 2025-11-11 10:21:03 -08:00			`<a href="https://github.com/google/adk-java">Java ADK</a>,`
			`<a href="https://github.com/google/adk-go">Go ADK</a> &`
Copybara import of the project: 2025-05-23 16:09:52 -07:00			`<a href="https://github.com/google/adk-web">ADK Web</a>.`
Changes for 0.1.0 release 2025-04-09 04:24:34 +00:00			`</h3>`
			`</html>`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00
chore: Revise README for clarity and consistency 2025-10-30 11:02:00 -07:00			`Agent Development Kit (ADK) is a flexible and modular framework that applies`
			`software development principles to AI agent creation. It is designed to`
			`simplify building, deploying, and orchestrating agent workflows, from simple`
			`tasks to complex systems. While optimized for Gemini, ADK is model-agnostic,`
			`deployment-agnostic, and compatible with other frameworks.`
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			`---`

chore: Add Tool Confirmation to README 2025-09-11 22:33:29 -07:00			`## 🔥 What's new`
docs: Add What's new section to README.md 2025-08-21 16:24:58 -07:00
chore: Fix spelling in markdown files 2025-11-05 20:30:17 -08:00			`- Custom Service Registration: Add a service registry to provide a generic way to register custom service implementations to be used in FastAPI server. See [short instruction](https://github.com/google/adk-python/discussions/3175#discussioncomment-14745120). ([391628f](https://github.com/google/adk-python/commit/391628fcdc7b950c6835f64ae3ccab197163c990))`
docs: Add What's new section to README.md 2025-08-21 16:24:58 -07:00
chore: Update ADK README with new features 2025-10-22 20:35:57 -07:00			`- Rewind: Add the ability to rewind a session to before a previous invocation ([9dce06f](https://github.com/google/adk-python/commit/9dce06f9b00259ec42241df4f6638955e783a9d1)).`
chore: Update README md with recent ADK features 2025-10-09 21:23:02 -07:00
chore: Update ADK README with new features 2025-10-22 20:35:57 -07:00			`- New CodeExecutor: Introduces a new AgentEngineSandboxCodeExecutor class that supports executing agent-generated code using the Vertex AI Code Execution Sandbox API ([ee39a89](https://github.com/google/adk-python/commit/ee39a891106316b790621795b5cc529e89815a98))`
chore: Add Tool Confirmation to README 2025-09-11 22:33:29 -07:00
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			`## ✨ Key Features`

Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`- Rich Tool Ecosystem: Utilize pre-built tools, custom functions,`
chore: Revise README for clarity and consistency 2025-10-30 11:02:00 -07:00			`OpenAPI specs, MCP tools or integrate existing tools to give agents diverse`
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`capabilities, all for tight integration with the Google ecosystem.`

			`- Code-First Development: Define agent logic, tools, and orchestration`
			`directly in Python for ultimate flexibility, testability, and versioning.`

chore: Update README md with recent ADK features 2025-10-09 21:23:02 -07:00			`- Agent Config: Build agents without code. Check out the`
			`[Agent Config](https://google.github.io/adk-docs/agents/config/) feature.`

			`- Tool Confirmation: A [tool confirmation flow(HITL)](https://google.github.io/adk-docs/tools/confirmation/) that can guard tool execution with explicit confirmation and custom input.`

Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`- Modular Multi-Agent Systems: Design scalable applications by composing`
			`multiple specialized agents into flexible hierarchies.`

			`- Deploy Anywhere: Easily containerize and deploy agents on Cloud Run or`
			`scale seamlessly with Vertex AI Agent Engine.`

Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			`## 🚀 Installation`

chore: Update README.md (#353 ) 2025-04-22 18:18:44 -07:00			`### Stable Release (Recommended)`

			You can install the latest stable version of ADK using `pip`:
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00
			```bash
			`pip install google-adk`
			```
No public description 2025-04-17 19:50:22 +00:00
chore: Update release cadence in README 2025-09-05 11:02:29 -07:00			`The release cadence is roughly bi-weekly.`
chore: Update README.md (#353 ) 2025-04-22 18:18:44 -07:00
			`This version is recommended for most users as it represents the most recent official release.`

			`### Development Version`
			`Bug fixes and new features are merged into the main branch on GitHub first. If you need access to changes that haven't been included in an official PyPI release yet, you can install directly from the main branch:`

			```bash
			`pip install git+https://github.com/google/adk-python.git@main`
			```

			`Note: The development version is built directly from the latest code commits. While it includes the newest fixes and features, it may also contain experimental changes or bugs not present in the stable release. Use it primarily for testing upcoming changes or accessing critical fixes before they are officially released.`

chore: Revise README for clarity and consistency 2025-10-30 11:02:00 -07:00			`## 🤖 Agent2Agent (A2A) Protocol and ADK Integration`

			`For remote agent-to-agent communication, ADK integrates with the`
			`[A2A protocol](https://github.com/google-a2a/A2A/).`
			`See this [example](https://github.com/a2aproject/a2a-samples/tree/main/samples/python/agents)`
			`for how they can work together.`

Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`## 📚 Documentation`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`Explore the full documentation for detailed guides on building, evaluating, and`
			`deploying agents:`
Update README.md (#104 ) 2025-04-11 20:03:44 -07:00
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`* [Documentation](https://google.github.io/adk-docs)`
Update README.md (#104 ) 2025-04-11 20:03:44 -07:00
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`## 🏁 Feature Highlight`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`### Define a single agent:`
No public description 2025-04-17 19:50:22 +00:00
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			```python
			`from google.adk.agents import Agent`
			`from google.adk.tools import google_search`

			`root_agent = Agent(`
			`name="search_assistant",`
chore: Update model references in README 2025-09-11 12:47:52 -07:00			`model="gemini-2.5-flash", # Or your preferred Gemini model`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			`instruction="You are a helpful assistant. Answer user questions using Google Search when needed.",`
			`description="An assistant that can search the web.",`
			`tools=[google_search]`
			`)`
			```

Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`### Define a multi-agent system:`
No public description 2025-04-17 19:50:22 +00:00
Fixed typo in README.md : cooridnator -> coordinator (#112 ) 2025-04-12 19:46:22 +05:30			`Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents works together to accomplish the task.`
No public description 2025-04-17 19:50:22 +00:00
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			```python
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`from google.adk.agents import LlmAgent, BaseAgent`

			`# Define individual agents`
chore: Update model references in README 2025-09-11 12:47:52 -07:00			`greeter = LlmAgent(name="greeter", model="gemini-2.5-flash", ...)`
			`task_executor = LlmAgent(name="task_executor", model="gemini-2.5-flash", ...)`
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00
			`# Create parent agent and assign children via sub_agents`
			`coordinator = LlmAgent(`
			`name="Coordinator",`
chore: Update model references in README 2025-09-11 12:47:52 -07:00			`model="gemini-2.5-flash",`
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`description="I coordinate greetings and tasks.",`
			`sub_agents=[ # Assign sub_agents here`
			`greeter,`
Update README.md (#185 ) 2025-04-14 22:03:36 +02:00			`task_executor`
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`]`
			`)`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			```

Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`### Development UI`

			`A built-in development UI to help you test, evaluate, debug, and showcase your agent(s).`

No public description 2025-04-17 19:50:22 +00:00			`<img src="https://raw.githubusercontent.com/google/adk-python/main/assets/adk-web-dev-ui-function-call.png"/>`
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00
			`### Evaluate Agents`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00
			```bash
Update README.md (#107 ) 2025-04-11 22:49:13 -07:00			`adk eval \`
			`samples_for_testing/hello_world \`
			`samples_for_testing/hello_world/hello_world_eval_set_001.evalset.json`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			```

			`## 🤝 Contributing`

chore: Adds link to Java ADK in README.md 2025-05-20 11:29:23 -07:00			`We welcome contributions from the community! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our`
fix: update contributing links 2025-06-24 14:26:45 -07:00			`- [General contribution guideline and flow](https://google.github.io/adk-docs/contributing-guide/).`
chore: Update README.md (#328 ) 2025-04-22 17:20:24 -07:00			`- Then if you want to contribute code, please read [Code Contributing Guidelines](./CONTRIBUTING.md) to get started.`
Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00
chore: Add Community Repo section to README 2025-11-04 15:17:13 -08:00			`## Community Repo`

			`We have [adk-python-community repo](https://github.com/google/adk-python-community)that is home to a growing ecosystem of community-contributed tools, third-party`
			`service integrations, and deployment scripts that extend the core capabilities`
			`of the ADK.`

docs: Update documents about the information of viber coding 2025-07-28 17:18:18 -07:00			`## Vibe Coding`

			`If you are to develop agent via vibe coding the [llms.txt](./llms.txt) and the [llms-full.txt](./llms-full.txt) can be used as context to LLM. While the former one is a summarized one and the later one has the full information in case your LLM has big enough context window.`

chore: Add Community Events section to README 2025-10-23 21:10:14 -07:00			`## Community Events`

			`- [Completed] ADK's 1st community meeting on Wednesday, October 15, 2025. Remember to [join our group](https://groups.google.com/g/adk-community) to get access to the [recording](https://drive.google.com/file/d/1rpXDq5NSH8-MyMeYI6_5pZ3Lhn0X9BQf/view), and [deck](https://docs.google.com/presentation/d/1_b8LG4xaiadbUUDzyNiapSFyxanc9ZgFdw7JQ6zmZ9Q/edit?slide=id.g384e60cdaca_0_658&resourcekey=0-tjFFv0VBQhpXBPCkZr0NOg#slide=id.g384e60cdaca_0_658).`

Agent Development Kit(ADK) 2025-04-08 17:22:09 +00:00			`## 📄 License`

			`This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.`

			`---`

Update README.md 2025-04-09 05:41:54 -07:00			`Happy Agent Building!`