You've already forked adk-python
mirror of
https://github.com/encounter/adk-python.git
synced 2026-07-09 18:19:28 -07:00
Josh Soref
e568558674
Merge https://github.com/google/adk-python/pull/3403 This PR corrects misspellings identified by the [check-spelling action](https://github.com/marketplace/actions/check-spelling) Note: while I use tooling to identify errors, the tooling doesn't _actually_ provide the corrections, I'm picking them on my own. I'm a human, and I may make mistakes. ### Testing Plan The misspellings have been reported at https://github.com/jsoref/adk-python/actions/runs/19056081305/attempts/1#summary-54426435973 The action reports that the changes in this PR would make it happy: https://github.com/jsoref/adk-python/actions/runs/19056081446/attempts/1#summary-54426436321 **Unit Tests:** - [ ] I have added or updated unit tests for my change. - [ ] All unit tests pass locally. _Please include a summary of passed `pytest` results._ **Manual End-to-End (E2E) Tests:** _Please provide instructions on how to manually test your changes, including any necessary setup or configuration. Please provide logs or screenshots to help reviewers better understand the fix._ ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] New and existing unit tests pass locally with my changes. - [ ] I have manually tested my changes end-to-end. - [ ] Any dependent changes have been merged and published in downstream modules. ### Additional context - https://github.com/google/adk-python/pull/3382#issuecomment-3488654110 COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/3403 from jsoref:spelling-markdown 432b7ded3bddfe4a1d8127c50fd7a001f19bda83 PiperOrigin-RevId: 828754459
179 lines
7.9 KiB
Markdown
179 lines
7.9 KiB
Markdown
# Agent Development Kit (ADK)
|
|
|
|
[](LICENSE)
|
|
[](https://pypi.org/project/google-adk/)
|
|
[](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml)
|
|
[](https://www.reddit.com/r/agentdevelopmentkit/)
|
|
[](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 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-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!*
|