-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Remove redundant sections from llms.txt #4022
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
linikerruan3-gif
wants to merge
1
commit into
google:main
Choose a base branch
from
linikerruan3-gif:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,228 +1 @@ | ||
| # Agent Development Kit (ADK) | ||
|
|
||
| Agent Development Kit (ADK) | ||
|
|
||
| ## ADK Python Repository | ||
|
|
||
| Agent Development Kit (ADK) | ||
|
|
||
| An open-source, code-first Python toolkit for building, evaluating, and deploying sophisticated AI agents with flexibility and control. | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| ✨ 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. | ||
|
|
||
| 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. See this example for how they can work together. | ||
|
|
||
|
|
||
| 🚀 Installation | ||
|
|
||
|
|
||
| Stable Release (Recommended) | ||
|
|
||
|
|
||
| You can install the latest stable version of ADK using pip: | ||
|
|
||
|
|
||
| pip install google-adk | ||
|
|
||
|
|
||
|
|
||
| The release cadence is 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: | ||
|
|
||
|
|
||
| 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 | ||
|
|
||
|
|
||
|
|
||
|
|
||
| 🏁 Feature Highlight | ||
|
|
||
|
|
||
| Define a single agent: | ||
|
|
||
|
|
||
| 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. | ||
|
|
||
|
|
||
| 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). | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Evaluate Agents | ||
|
|
||
|
|
||
| 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 | ||
| . | ||
| - Then if you want to contribute code, please read | ||
| Code Contributing Guidelines | ||
| to get started. | ||
|
|
||
|
|
||
| 📄 License | ||
|
|
||
|
|
||
| This project is licensed under the Apache 2.0 License - see the LICENSE file for details. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Happy Agent Building! | ||
|
|
||
| **Source:** [adk-python repository](https://github.com/google/adk-python) | ||
|
|
||
| ## Documentation | ||
| - [Custom agents](https://github.com/google/adk-docs/blob/main/docs/agents/custom-agents.md) | ||
| - [Agents](https://github.com/google/adk-docs/blob/main/docs/agents/index.md) | ||
| - [LLM Agent](https://github.com/google/adk-docs/blob/main/docs/agents/llm-agents.md) | ||
| - [Using Different Models with ADK](https://github.com/google/adk-docs/blob/main/docs/agents/models.md) | ||
| - [Multi-Agent Systems in ADK](https://github.com/google/adk-docs/blob/main/docs/agents/multi-agents.md) | ||
| - [Workflow Agents](https://github.com/google/adk-docs/blob/main/docs/agents/workflow-agents/index.md) | ||
| - [Loop agents](https://github.com/google/adk-docs/blob/main/docs/agents/workflow-agents/loop-agents.md) | ||
| - [Parallel agents](https://github.com/google/adk-docs/blob/main/docs/agents/workflow-agents/parallel-agents.md) | ||
| - [Sequential agents](https://github.com/google/adk-docs/blob/main/docs/agents/workflow-agents/sequential-agents.md) | ||
| - [API Reference](https://github.com/google/adk-docs/blob/main/docs/api-reference/index.md) | ||
| - [Artifacts](https://github.com/google/adk-docs/blob/main/docs/artifacts/index.md) | ||
| - [Design Patterns and Best Practices for Callbacks](https://github.com/google/adk-docs/blob/main/docs/callbacks/design-patterns-and-best-practices.md) | ||
| - [Callbacks: Observe, Customize, and Control Agent Behavior](https://github.com/google/adk-docs/blob/main/docs/callbacks/index.md) | ||
| - [Types of Callbacks](https://github.com/google/adk-docs/blob/main/docs/callbacks/types-of-callbacks.md) | ||
| - [Community Resources](https://github.com/google/adk-docs/blob/main/docs/community.md) | ||
| - [Context](https://github.com/google/adk-docs/blob/main/docs/context/index.md) | ||
| - [1. [`google/adk-python`](https://github.com/google/adk-python)](https://github.com/google/adk-docs/blob/main/docs/contributing-guide.md) | ||
| - [Deploy to Vertex AI Agent Engine](https://github.com/google/adk-docs/blob/main/docs/deploy/agent-engine.md) | ||
| - [Deploy to Cloud Run](https://github.com/google/adk-docs/blob/main/docs/deploy/cloud-run.md) | ||
| - [Deploy to GKE](https://github.com/google/adk-docs/blob/main/docs/deploy/gke.md) | ||
| - [Deploying Your Agent](https://github.com/google/adk-docs/blob/main/docs/deploy/index.md) | ||
| - [Why Evaluate Agents](https://github.com/google/adk-docs/blob/main/docs/evaluate/index.md) | ||
| - [Events](https://github.com/google/adk-docs/blob/main/docs/events/index.md) | ||
| - [Agent Development Kit (ADK)](https://github.com/google/adk-docs/blob/main/docs/get-started/about.md) | ||
| - [Get Started](https://github.com/google/adk-docs/blob/main/docs/get-started/index.md) | ||
| - [Installing ADK](https://github.com/google/adk-docs/blob/main/docs/get-started/installation.md) | ||
| - [Quickstart](https://github.com/google/adk-docs/blob/main/docs/get-started/quickstart.md) | ||
| - [Streaming Quickstarts](https://github.com/google/adk-docs/blob/main/docs/get-started/streaming/index.md) | ||
| - [Quickstart (Streaming / Java) {#adk-streaming-quickstart-java}](https://github.com/google/adk-docs/blob/main/docs/get-started/streaming/quickstart-streaming-java.md) | ||
| - [Quickstart (Streaming / Python) {#adk-streaming-quickstart}](https://github.com/google/adk-docs/blob/main/docs/get-started/streaming/quickstart-streaming.md) | ||
| - [Testing your Agents](https://github.com/google/adk-docs/blob/main/docs/get-started/testing.md) | ||
| - [What is Agent Development Kit?](https://github.com/google/adk-docs/blob/main/docs/index.md) | ||
| - [Model Context Protocol (MCP)](https://github.com/google/adk-docs/blob/main/docs/mcp/index.md) | ||
| - [Agent Observability with Arize AX](https://github.com/google/adk-docs/blob/main/docs/observability/arize-ax.md) | ||
| - [Agent Observability with Phoenix](https://github.com/google/adk-docs/blob/main/docs/observability/phoenix.md) | ||
| - [Runtime](https://github.com/google/adk-docs/blob/main/docs/runtime/index.md) | ||
| - [Runtime Configuration](https://github.com/google/adk-docs/blob/main/docs/runtime/runconfig.md) | ||
| - [Safety & Security for AI Agents](https://github.com/google/adk-docs/blob/main/docs/safety/index.md) | ||
| - [Introduction to Conversational Context: Session, State, and Memory](https://github.com/google/adk-docs/blob/main/docs/sessions/index.md) | ||
| - [Memory: Long-Term Knowledge with `MemoryService`](https://github.com/google/adk-docs/blob/main/docs/sessions/memory.md) | ||
| - [Session: Tracking Individual Conversations](https://github.com/google/adk-docs/blob/main/docs/sessions/session.md) | ||
| - [State: The Session's Scratchpad](https://github.com/google/adk-docs/blob/main/docs/sessions/state.md) | ||
| - [Configurating streaming behaviour](https://github.com/google/adk-docs/blob/main/docs/streaming/configuration.md) | ||
| - [Custom Audio Streaming app (WebSocket) {#custom-streaming-websocket}](https://github.com/google/adk-docs/blob/main/docs/streaming/custom-streaming-ws.md) | ||
| - [Custom Audio Streaming app (SSE) {#custom-streaming}](https://github.com/google/adk-docs/blob/main/docs/streaming/custom-streaming.md) | ||
| - [ADK Bidi-streaming development guide: Part 1 - Introduction](https://github.com/google/adk-docs/blob/main/docs/streaming/dev-guide/part1.md) | ||
| - [Bidi-streaming(live) in ADK](https://github.com/google/adk-docs/blob/main/docs/streaming/index.md) | ||
| - [Streaming Tools](https://github.com/google/adk-docs/blob/main/docs/streaming/streaming-tools.md) | ||
| - [Authenticating with Tools](https://github.com/google/adk-docs/blob/main/docs/tools/authentication.md) | ||
| - [Built-in tools](https://github.com/google/adk-docs/blob/main/docs/tools/built-in-tools.md) | ||
| - [Function tools](https://github.com/google/adk-docs/blob/main/docs/tools/function-tools.md) | ||
| - [Google Cloud Tools](https://github.com/google/adk-docs/blob/main/docs/tools/google-cloud-tools.md) | ||
| - [Tools](https://github.com/google/adk-docs/blob/main/docs/tools/index.md) | ||
| - [Model Context Protocol Tools](https://github.com/google/adk-docs/blob/main/docs/tools/mcp-tools.md) | ||
| - [OpenAPI Integration](https://github.com/google/adk-docs/blob/main/docs/tools/openapi-tools.md) | ||
| - [Third Party Tools](https://github.com/google/adk-docs/blob/main/docs/tools/third-party-tools.md) | ||
| - [Build Your First Intelligent Agent Team: A Progressive Weather Bot with ADK](https://github.com/google/adk-docs/blob/main/docs/tutorials/agent-team.md) | ||
| - [ADK Tutorials!](https://github.com/google/adk-docs/blob/main/docs/tutorials/index.md) | ||
| - [Python API Reference](https://github.com/google/adk-docs/blob/main/docs/api-reference/python/) | ||
| https://github-enterprise.s3.amazonaws.com/kvm/updates/github-enterprise-kvm-3.14.21.pkg | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change replaces over 200 lines of documentation with a single URL pointing to a downloadable package (
.pkg). This is a critical security risk. The filellms.txtis intended to be a text-based documentation resource, as indicated by thecontributing/dev/utils/build_llms_txt.pyscript. Replacing its content with a link to a binary file is a major security red flag and could be an attempt to distribute malware. This change must be rejected.