Skip to content

templateconfig.yaml Reference

This document provides a detailed reference for all the available fields in the templateconfig.yaml file. This file is used to configure both the built-in agents provided by the starter pack and your own remote templates.

Top-Level Fields

FieldTypeRequiredDescription
base_templatestringYes (for remote agents only)The name of the built-in agent that the remote template will inherit from (e.g., adk_base, agentic_rag).
namestringYesThe display name of your template, shown in the list command.
descriptionstringYesA brief description of your template, also shown in the list command.
example_questionstringNoAn example question or prompt that will be included in the generated project's README.md.
settingsobjectNoA nested object containing detailed configuration for the template. See settings section below.

The settings Object

This object contains fields that control the generated project's features and behavior.

FieldTypeDescription
deployment_targetslist(string)A list of deployment targets your template supports. Options: agent_engine, cloud_run.
tagslist(string)A list of tags for categorization. The adk tag enables special integrations with the Agent Development Kit.
frontend_typestringSpecifies the frontend to use. Examples: streamlit, live_api_react. Defaults to streamlit.
requires_data_ingestionbooleanIf true, the user will be prompted to configure a datastore.
requires_sessionbooleanIf true, the user will be prompted to choose a session storage type (e.g., alloydb) when using the cloud_run target.
interactive_commandstringThe make command to run for starting the agent, after the agent code is being created (e.g., make playground, make dev). Defaults to playground.
extra_dependencieslist(string)Note: This field is ignored by remote templates. It is used internally by the starter pack's built-in templates. Your pyproject.toml is the single source of truth for dependencies.

Released under the Apache 2.0 License.