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/)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/google/adk-python)

<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 toolkit 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-web">ADK Web</a>.
    </h3>
</html>

Agent Development Kit (ADK) is a flexible and modular framework for developing and deploying AI agents. While optimized for Gemini and the Google ecosystem, ADK is model-agnostic, deployment-agnostic, and is built for compatibility with other frameworks. ADK was designed to make agent development feel more like software development, to make it easier for developers to create, deploy, and orchestrate agentic architectures that range from simple tasks to complex workflows.

---

## 🔥 What's new

- **Context compaction**: Supports context compaction to reduce context length. Here is a [sample](https://github.com/google/adk-python/blob/main/contributing/samples/hello_world_app/agent.py#L156) and [compaction config](https://github.com/google/adk-python/blob/main/src/google/adk/apps/app.py#L51).

- **Resumability**: Support pause and resume an invocation in ADK.

- **ReflectRetryToolPlugin**: Add [`ReflectRetryToolPlugin`](https://github.com/google/adk-python/blob/main/src/google/adk/plugins/reflect_retry_tool_plugin.py) to reflect from errors and retry with different arguments when tool errors.

- **Search tool**: Support using Google built-in search and built-in `VertexAiSearchTool` with other tools in the same agent.

## ✨ Key Features

- **Rich Tool Ecosystem**: Utilize pre-built tools, custom functions,
  OpenAPI specs, 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.

## 🤖 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.

## 🚀 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.

## 📚 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.

## 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.

## 📄 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/)`
feat: Add DeepWiki badge to README 2025-06-09 13:35:04 -07:00			`[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/google/adk-python)`
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">`
			`An open-source, code-first Python toolkit for building, evaluating, and deploying sophisticated AI agents with flexibility and control.`
			`</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>,`
			`<a href="https://github.com/google/adk-java">Java ADK</a> &`
			`<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
update readme 2025-04-24 15:49:17 -07:00			`Agent Development Kit (ADK) is a flexible and modular framework for developing and deploying AI agents. While optimized for Gemini and the Google ecosystem, ADK is model-agnostic, deployment-agnostic, and is built for compatibility with other frameworks. ADK was designed to make agent development feel more like software development, to make it easier for developers to create, deploy, and orchestrate agentic architectures that range from simple tasks to complex workflows.`
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: Update README md with recent ADK features 2025-10-09 21:23:02 -07:00			`- Context compaction: Supports context compaction to reduce context length. Here is a [sample](https://github.com/google/adk-python/blob/main/contributing/samples/hello_world_app/agent.py#L156) and [compaction config](https://github.com/google/adk-python/blob/main/src/google/adk/apps/app.py#L51).`
docs: Add What's new section to README.md 2025-08-21 16:24:58 -07:00
chore: Update README md with recent ADK features 2025-10-09 21:23:02 -07:00			`- Resumability: Support pause and resume an invocation in ADK.`

			- ReflectRetryToolPlugin: Add [`ReflectRetryToolPlugin`](https://github.com/google/adk-python/blob/main/src/google/adk/plugins/reflect_retry_tool_plugin.py) to reflect from errors and retry with different arguments when tool errors.

			- Search tool: Support using Google built-in search and built-in `VertexAiSearchTool` with other tools in the same agent.
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,`
			`OpenAPI specs, 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.`

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.`

Copybara import of the project: 2025-05-23 16:09:52 -07:00			`## 🤖 Agent2Agent (A2A) Protocol and ADK Integration`

			`For remote agent-to-agent communication, ADK integrates with the`
Copybara import of the project: 2025-05-29 16:49:09 -07:00			`[A2A protocol](https://github.com/google-a2a/A2A/).`
doc: Update README.md 2025-07-01 21:05:43 -07:00			`See this [example](https://github.com/a2aproject/a2a-samples/tree/main/samples/python/agents)`
Copybara import of the project: 2025-05-23 16:09:52 -07:00			`for how they can work together.`
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.`

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
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.`

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!`