README.md

Examples

This directory contains example agents that serve three purposes:

1. Standalone agents — Each example is a fully functional agent that can be run independently for learning and experimentation.

2. E2E tests — Examples are used in end-to-end tests located in apps/adk-server/tests/e2e/examples/. This ensures all examples remain working and up-to-date. See E2E example tests below.

3. Documentation — Examples are embedded directly into the docs using embedme tags:

   {/* <!-- embedme examples/agent-integration/multi-turn/basic-history/src/basic_history/agent.py --> */}

   This keeps documentation code samples in sync with actual tested examples.

Folder structure

The examples/ folder structure mirrors the docs structure. For instance, examples used in docs/development/agent-integration/forms.mdx live under examples/agent-integration/forms/.

Each doc section heading maps to an example name. For example, the "Initial Form Rendering" section in forms.mdx corresponds to the example at examples/agent-integration/forms/initial-form-rendering/.

Naming convention

The template names the agent function as <snake_case_name>_example. The example name is derived from the doc section heading where it's used:

• Doc heading: "Initial Form Rendering"
• Example path: agent-integration/forms/initial-form-rendering
• Agent function: initial_form_rendering_example

Modifying an existing example

1. Edit the agent code in examples/<path>/src/<name>/agent.py
2. Run the related e2e test in apps/adk-server/tests/e2e/examples/<path>/test_<name>.py
3. Sync embedded code into docs: mise run docs:fix

Creating a new example

Use the mise command to scaffold a new example and its e2e test from the templates in .template/.

mise run example:create <path> <description>

• path -- path relative to examples/, e.g. agent-integration/multi-turn/basic-history
• description -- short description of the example

The script automatically derives:

• project name from the last folder in the path (e.g. basic-history)
• Python package name by converting to snake_case (e.g. basic_history)
• SDK relative path from the directory depth

Example

mise run example:create agent-integration/multi-turn/basic-history "Example demonstrating basic history."

This creates:

examples/agent-integration/multi-turn/basic-history/
  pyproject.toml
  src/basic_history/
    __init__.py
    agent.py

apps/adk-server/tests/e2e/examples/agent-integration/multi-turn/
  test_basic_history.py

It also adds a VS Code debug configuration to examples/.vscode/launch.json.

After scaffolding:

1. Implement the agent logic in examples/<path>/src/<name>/agent.py
2. Implement the e2e test in apps/adk-server/tests/e2e/examples/<path>/test_<name>.py
3. Embed the example in docs using an embedme tag:

   {/* <!-- embedme examples/<path>/src/<name>/agent.py --> */}

4. Sync embedded code into docs: mise run docs:fix

Template placeholders

The template files in .template/ use %{...} placeholders:

Placeholder	Replaced with	Example
%{EXAMPLE_NAME}	Project name (kebab-case)	basic-history
%{EXAMPLE_DESCRIPTION}	Description	Example demonstrating basic history.
%{EXAMPLE_NAME_SNAKE_CASE}	Python package name	basic_history
%{SDK_PATH}	Relative path to SDK	../../../../apps/adk-py

The directory src/example_name/ and the function name example_name in agent.py are also renamed to the snake_case name.

E2E example tests

E2E example tests run separately from the core e2e tests to avoid slowing down the main test suite.

How to run

Command	What it runs
mise run adk-server:test:e2e	Core e2e tests only (excludes examples)
mise run adk-server:test:e2e-examples	Example e2e tests only

When they run in CI

• On push to main — automatically, when files change in apps/adk-server/, apps/adk-py/, or examples/.
• On pull requests — add the e2e-examples label to the PR. Tests will run when the label is added and on every subsequent push.
• Manually — trigger the e2e-examples-test workflow via GitHub Actions.