# Google ADK 2.0 Setup & Workflow Guide
> Bilingual guide for Google's Agent Development Kit (ADK) 2.0: Python 3.11+ install, CLI usage, and workflow orchestration.
## Install
Copy the content below into your project:
# Google ADK 2.0 Setup & Workflow Guide
Bilingual guide for Google's Agent Development Kit (ADK) 2.0: Python 3.11+ install, CLI usage, and workflow orchestration.
## Quick Use
This guide covers the setup and basic execution of the Agent Development Kit (ADK). The source code is reviewed but runtime execution has not been verified by this editor.
1. **Install Dependencies**: Ensure you have Python 3.11 or higher installed. Install the package using `pip`:
```bash
pip install google-adk
```
For dependency protection, use the provided constraints file matching your Python version:
```bash
curl -o constraints-3.11.txt https://raw.githubusercontent.com/google/adk-python/main/constraints-3.11.txt
pip install google-adk -c constraints-3.11.txt
rm constraints-3.11.txt
```
2. **Create an Agent**: Define a simple agent in a Python file (e.g., `my_agent.py`).
```python
from google.adk import Agent
root_agent = Agent(
name="greeting_agent",
model="gemini-3.5-flash",
instruction="You are a helpful assistant. Greet the user warmly.",
)
```
3. **Run Locally**: Use the ADK CLI to run your agent interactively.
```bash
adk run path/to/my_agent
```
Source reviewed; runtime not tested.
## Introduction
The Agent Development Kit (ADK) is an open-source, code-first Python framework designed to build, evaluate, and deploy sophisticated AI agents. It features a graph-based execution engine for composing deterministic workflows, supporting routing, loops, and state management. While optimized for Gemini models, it remains model-agnostic.
### Prerequisites
* **Python**: Version 3.11 or higher is required.
* **Package Manager**: `pip`.
* **Environment**: A terminal or command prompt with access to Python.
### Permissions and Limitations
* **Permissions**: The installation process requires network access to download packages from PyPI. Deployment commands may require authentication to Google Cloud services if using Cloud Run or Vertex AI.
* **Limitations**: This guide documents the standard installation and local CLI usage. Runtime verification of the `adk run` command was not performed. Advanced deployment features depend on external cloud infrastructure configurations not covered here.
## FAQ
**Q: Can I use models other than Gemini?**
A: Yes, ADK is model-agnostic. While the examples often reference Gemini, the framework supports integration with other models through its tool ecosystem and configuration.
**Q: How do I install optional integrations?**
A: You can install extension modules by running: `pip install "google-adk[extensions]"`. This allows for tighter integration with specific tools or services.
## Source and Thanks
Source: [google/adk-python](https://github.com/google/adk-python) at commit `29bb0532c48abad0314cecea5a30b3cdaf6d7898`. Licensed under Apache 2.0. Documentation adapted from the official [ADK Docs](https://adk.dev/).
## Complete upstream material
# Agent Development Kit (ADK) 2.0
[](LICENSE)
[](https://pypi.org/project/google-adk/)
[](https://pypi.org/project/google-adk/)
[](https://pepy.tech/project/google-adk)
[](https://github.com/google/adk-python/actions/workflows/continuous-integration.yml)
[](https://adk.dev/)
[](https://www.reddit.com/r/agentdevelopmentkit/)
An open-source, code-first Python framework for building, evaluating, and deploying sophisticated AI agents with flexibility and control.
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.
## ✨ Key Features
- **Workflow Runtime**: A graph-based execution engine for composing
deterministic execution flows for agentic apps, with support for routing,
fan-out/fan-in, loops, retry, state management, dynamic nodes,
human-in-the-loop, and nested workflows.
- **Task API**: Structured agent-to-agent delegation with multi-turn task
mode, single-turn controlled output, mixed delegation patterns,
human-in-the-loop, and task agents as workflow nodes.
- **Modular Multi-Agent Systems**: Design scalable applications by composing
multiple specialized agents into flexible hierarchies.
- **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://adk.dev/agents/config/) feature.
- **Tool Confirmation**: A [tool confirmation flow (HITL)](https://adk.dev/tools-custom/confirmation/) that can guard tool execution with explicit confirmation and custom input.
- **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
```
**Requirements:** Python 3.11+.
For transitive dependency protection, we recommend installing with our companion
constraints files (for python 3.11 to 3.15).
Choose the constraints file matching your Python version:
```bash
# For example, for Python 3.11
curl -o constraints-3.11.txt https://raw.githubusercontent.com/google/adk-python/main/constraints-3.11.txt
pip install google-adk -c constraints-3.11.txt
rm constraints-3.11.txt
```
To install optional integrations, you can use the following command:
```bash
pip install "google-adk[extensions]"
```
The release cadence is roughly bi-weekly.
### 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.
## Quick Start
> **Beginner Note:** ADK applications are built using two main classes:
> **`Agent`** (defines an AI's instructions, tools, and behavior) and
> **`Workflow`** (orchestrates agents and tasks in a graph-based flow).
### Agent
```python
from google.adk import Agent
root_agent = Agent(
name="greeting_agent",
model="gemini-3.5-flash",
instruction="You are a helpful assistant. Greet the user warmly.",
)
```
### Workflow
```python
from google.adk import Agent, Workflow
generate_fruit_agent = Agent(
name="generate_fruit_agent",
instruction="Return the name of a random fruit. Return only the name.",
)
generate_benefit_agent = Agent(
name="generate_benefit_agent",
instruction="Tell me a health benefit about the specified fruit.",
)
root_agent = Workflow(
name="root_agent",
edges=[("START", generate_fruit_agent, generate_benefit_agent)],
)
```
### Run Locally
```bash
# Interactive CLI
adk run path/to/my_agent
# Web UI (supports multi-agent directories or pointing directly to a single agent folder)
adk web path/to/agents_dir
```
### Development UI
A built-in development UI to help you test, evaluate, debug, and showcase your agent(s).
[](https://youtu.be/TEjqk0eeNy8)
[](https://youtu.be/TEjqk0eeNy8)
### Evaluate Agents
Run the bundled evaluation sample from the repo root:
```bash
adk eval \
contributing/samples/evaluation/home_automation_agent \
contributing/samples/evaluation/basic_criteria/home_automation.evalset.json \
--config_file_path contributing/samples/evaluation/basic_criteria/eval_config.json
```
### 🚀 Deployment Options
Deploying the Agent Locally with Docker Container:
```bash
adk deploy docker --with_ui
```
Deploying the Agent in Google Cloud (Cloud Run)
```bash
adk deploy cloud_run --with_ui
```
You may set the following environment variables in adk command, or in a .env file instead.
```bash
adk deploy cloud_run --with_ui --env GOOGLE_GENAI_USE_ENTERPRISE=1
```
## 📚 Documentation
- **Getting Started**: https://adk.dev/
- **Guides**: See
[`docs/guides/`](https://github.com/google/adk-python/tree/main/docs/guides)
for task-oriented walkthroughs of agents, tools, events, plugins, and
workflows.
- **Samples**: See
[`contributing/samples/`](https://github.com/google/adk-python/tree/main/contributing/samples)
for runnable example agents.
## 🤝 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://adk.dev/community/contributing-guide/).
- [Code Contributing Guidelines](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/CONTRIBUTING.md) to get started.
## Community Repo
We have the [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 want to develop an agent via vibe coding, the [llms.txt](https://adk.dev/llms.txt) and [llms-full.txt](https://adk.dev/llms-full.txt) files published on the ADK documentation site can be used as context for an LLM. The former is a summarized version, while the latter contains the full documentation for LLMs with a large 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](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/LICENSE) file for details.
______________________________________________________________________
*Happy Agent Building!*
## Source and license
[Source](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/README.md) · [License](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/LICENSE) · `29bb0532c48abad0314cecea5a30b3cdaf6d7898`
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---
# Google ADK 2.0 安装与工作流指南
Google Agent Development Kit (ADK) 2.0 双语指南:Python 3.11+ 安装、命令行使用及工作流编排。
## 快速使用
本指南介绍 Agent Development Kit (ADK) 的安装和基本执行方法。源码已审阅,但运行时执行未经过本编辑器验证。
1. **安装依赖**:确保您已安装 Python 3.11 或更高版本。使用 `pip` 安装包:
```bash
pip install google-adk
```
为了依赖保护,请使用与您的 Python 版本匹配的约束文件:
```bash
curl -o constraints-3.11.txt https://raw.githubusercontent.com/google/adk-python/main/constraints-3.11.txt
pip install google-adk -c constraints-3.11.txt
rm constraints-3.11.txt
```
2. **创建 Agent**:在 Python 文件(例如 `my_agent.py`)中定义一个简单的 agent。
```python
from google.adk import Agent
root_agent = Agent(
name="greeting_agent",
model="gemini-3.5-flash",
instruction="You are a helpful assistant. Greet the user warmly.",
)
```
3. **本地运行**:使用 ADK CLI 交互式地运行您的 agent。
```bash
adk run path/to/my_agent
```
已审阅源码;未做运行时测试。
## 介绍
Agent Development Kit (ADK) 是一个开源的、代码优先的 Python 框架,旨在构建、评估和部署复杂的 AI agent。它具有基于图的执行引擎,用于组合确定性工作流,支持路由、循环和状态管理。虽然针对 Gemini 模型进行了优化,但它保持模型无关性。
### 先决条件
* **Python**:需要版本 3.11 或更高版本。
* **包管理器**:`pip`。
* **环境**:可以访问 Python 的终端或命令提示符。
### 权限与限制
* **权限**:安装过程需要网络连接以下载 PyPI 上的包。如果使用 Cloud Run 或 Vertex AI,部署命令可能需要 Google Cloud 服务的身份验证。
* **限制**:本指南记录标准安装和本地 CLI 用法。未对 `adk run` 命令进行运行时验证。高级部署功能依赖于此处未涵盖的外部云基础架构配置。
## 常见问题
**问:我可以使用除 Gemini 之外的其他模型吗?**
答:是的,ADK 是模型无关的。虽然示例经常引用 Gemini,但该框架通过其工具生态系统和配置支持与其它模型的集成。
**问:如何安装可选集成?**
答:您可以运行以下命令来安装扩展模块:`pip install "google-adk[extensions]"`。这允许与特定工具或服务更紧密地集成。
## 来源与致谢
来源:[google/adk-python](https://github.com/google/adk-python),commit `29bb0532c48abad0314cecea5a30b3cdaf6d7898`。采用 Apache 2.0 许可证。文档改编自官方 [ADK 文档](https://adk.dev/)。
## 完整上游材料译文
# Agent Development Kit (ADK) 2.0
[](LICENSE)
[](https://pypi.org/project/google-adk/)
[](https://pypi.org/project/google-adk/)
[](https://pepy.tech/project/google-adk)
[](https://github.com/google/adk-python/actions/workflows/continuous-integration.yml)
[](https://adk.dev/)
[](https://www.reddit.com/r/agentdevelopmentkit/)
一个开源的、代码优先的 Python 框架,用于以灵活性和控制力构建、评估和部署复杂的 AI agent。
Agent Development Kit (ADK) 是一个灵活且模块化的框架,它将软件开发原则应用于 AI agent 的创建。它旨在简化 agent 工作流的构建、部署和编排,涵盖从简单任务到复杂系统的各种场景。虽然针对 Gemini 进行了优化,但 ADK 保持模型无关性、部署无关性,并与其他框架兼容。
## ✨ 主要特性
- **工作流运行时**:基于图的执行引擎,用于为 agent 应用组合确定性执行流,支持路由、扇出/扇入、循环、重试、状态管理、动态节点、人机协同以及嵌套工作流。
- **任务 API**:结构化的 agent 间委托机制,支持多轮任务模式、单轮受控输出、混合委托模式、人机协同,以及将任务 agent 作为工作流节点。
- **模块化多 Agent 系统**:通过将多个专用 agent 组合成灵活的层级结构,设计可扩展的应用程序。
- **丰富的工具生态系统**:利用预建工具、自定义函数、OpenAPI 规范、MCP 工具或集成现有工具,赋予 agent 多样化的能力,从而实现与 Google 生态系统的紧密集成。
- **代码优先开发**:直接在 Python 中定义 agent 逻辑、工具和编排流程,以实现最大的灵活性、可测试性和版本控制。
- **Agent 配置**:无需编写代码即可构建 agent。查看 [Agent Config](https://adk.dev/agents/config/) 功能。
- **工具确认**:[工具确认流程 (HITL)](https://adk.dev/tools-custom/confirmation/) 可以通过显式确认和自定义输入来保护工具执行。
- **随处部署**:轻松将 agent 容器化,并在 Cloud Run 上部署,或使用 Vertex AI Agent Engine 无缝扩展。
## 🚀 安装
### 稳定版(推荐)
您可以使用 `pip` 安装 ADK 的最新稳定版本:
```bash
pip install google-adk
```
**要求:** Python 3.11+。
为了传递依赖保护,我们建议使用配套的约束文件进行安装(适用于 Python 3.11 到 3.15)。
选择与您的 Python 版本匹配的约束文件:
```bash
# For example, for Python 3.11
curl -o constraints-3.11.txt https://raw.githubusercontent.com/google/adk-python/main/constraints-3.11.txt
pip install google-adk -c constraints-3.11.txt
rm constraints-3.11.txt
```
要安装可选集成,您可以使用以下命令:
```bash
pip install "google-adk[extensions]"
```
发布频率大致为每两周一次。
### 开发版本
Bug 修复和新功能首先合并到 GitHub 上的 main 分支。如果您需要访问尚未包含在官方 PyPI 版本中的更改,可以直接从 main 分支安装:
```bash
pip install git+https://github.com/google/adk-python.git@main
```
注意:开发版本直接基于最新的代码提交构建。虽然它包含了最新的修复和功能,但也可能包含稳定版中不存在的实验性更改或错误。主要用于测试即将发布的更改或在官方发布之前获取关键修复。
## 快速入门
> **初学者提示:** ADK 应用程序使用两个主要类构建:
> **`Agent`**(定义 AI 的指令、工具和行为)和
> **`Workflow`**(在基于图的流程中编排 agent 和任务)。
### Agent
```python
from google.adk import Agent
root_agent = Agent(
name="greeting_agent",
model="gemini-3.5-flash",
instruction="You are a helpful assistant. Greet the user warmly.",
)
```
### 工作流
```python
from google.adk import Agent, Workflow
generate_fruit_agent = Agent(
name="generate_fruit_agent",
instruction="Return the name of a random fruit. Return only the name.",
)
generate_benefit_agent = Agent(
name="generate_benefit_agent",
instruction="Tell me a health benefit about the specified fruit.",
)
root_agent = Workflow(
name="root_agent",
edges=[("START", generate_fruit_agent, generate_benefit_agent)],
)
```
### 本地运行
```bash
# Interactive CLI
adk run path/to/my_agent
# Web UI (supports multi-agent directories or pointing directly to a single agent folder)
adk web path/to/agents_dir
```
### 开发 UI
内置的开发 UI,帮助您测试、评估、调试和展示您的 agent。
[](https://youtu.be/TEjqk0eeNy8)
[](https://youtu.be/TEjqk0eeNy8)
### 评估 Agent
从仓库根目录运行捆绑的评估示例:
```bash
adk eval \
contributing/samples/evaluation/home_automation_agent \
contributing/samples/evaluation/basic_criteria/home_automation.evalset.json \
--config_file_path contributing/samples/evaluation/basic_criteria/eval_config.json
```
### 🚀 部署选项
使用 Docker 容器在本地部署 Agent:
```bash
adk deploy docker --with_ui
```
在 Google Cloud (Cloud Run) 中部署 Agent
```bash
adk deploy cloud_run --with_ui
```
您可以在 adk 命令中设置以下环境变量,或者在 .env 文件中设置。
```bash
adk deploy cloud_run --with_ui --env GOOGLE_GENAI_USE_ENTERPRISE=1
```
## 📚 文档
- **入门指南**: https://adk.dev/
- **指南**: 参见
[`docs/guides/`](https://github.com/google/adk-python/tree/main/docs/guides)
以获取关于 agent、工具、事件、插件和工作流的面向任务的演练。
- **示例**: 参见
[`contributing/samples/`](https://github.com/google/adk-python/tree/main/contributing/samples)
以获取可运行的示例 agent。
## 🤝 贡献
我们欢迎社区的贡献!无论是错误报告、功能请求、文档改进还是代码贡献,请参阅我们的:
- [常规贡献指南和流程](https://adk.dev/community/contributing-guide/)。
- [代码贡献指南](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/CONTRIBUTING.md) 以开始。
## 社区仓库
我们拥有 [adk-python-community 仓库](https://github.com/google/adk-python-community),其中包含不断增长的社区贡献工具、第三方服务集成和部署脚本生态系统,这些扩展了 ADK 的核心功能。
## Vibe Coding(氛围编程)
如果您希望通过 vibe coding 开发 agent,ADK 文档网站上发布的 [llms.txt](https://adk.dev/llms.txt) 和 [llms-full.txt](https://adk.dev/llms-full.txt) 文件可用作大语言模型(LLM)的上下文。前者是摘要版本,而后者包含适用于具有大上下文窗口的 LLM 的完整文档。
## 社区活动
- [已完成] ADK 第一次社区会议于 2025 年 10 月 15 日(星期三)举行。请记得[加入我们的群组](https://groups.google.com/g/adk-community)以获取[会议录像](https://drive.google.com/file/d/1rpXDq5NSH8-MyMeYI6_5pZ3Lhn0X9BQf/view)和[演示文稿](https://docs.google.com/presentation/d/1_b8LG4xaiadbUUDzyNiapSFyxanc9ZgFdw7JQ6zmZ9Q/edit?slide=id.g384e60cdaca_0_658&resourcekey=0-tjFFv0VBQhpXBPCkZr0NOg#slide=id.g384e60cdaca_0_658)的访问权限。
## 📄 许可证
本项目采用 Apache 2.0 许可证授权 — 详情请参阅
[LICENSE](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/LICENSE) 文件。
______________________________________________________________________
*祝您 Agent 构建愉快!*
## 来源与许可证
[Source](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/README.md) · [License](https://github.com/google/adk-python/blob/29bb0532c48abad0314cecea5a30b3cdaf6d7898/LICENSE) · `29bb0532c48abad0314cecea5a30b3cdaf6d7898`
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---
Source: https://tokrepo.com/en/workflows/google-adk-companion-guide-setup-permissions-limits-2a0fd7e0
Author: Agent Toolkit