Merge branch 'main' into ammmr-info-to-debug-connect-log

Author: hangfei

.github/ISSUE_TEMPLATE/bug_report.md

@@ -19,7 +19,7 @@ Steps to reproduce the behavior:
 1. Install '...'
 2. Run '....'
 3. Open '....'
-4. Provie error or stacktrace
+4. Provide error or stacktrace
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.

CHANGELOG.md

@@ -32,7 +32,7 @@ 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 [here](https://github.com/google/adk-python/discussions/3175#discussioncomment-14745120). ([391628f](https://github.com/google/adk-python/commit/391628fcdc7b950c6835f64ae3ccab197163c990))
+- **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)).
 

README.md

@@ -15,6 +15,8 @@
 """Agent factory for creating Agent Builder Assistant with embedded schema."""
 
 from pathlib import Path
+import textwrap
+from typing import Any
 from typing import Callable
 from typing import Optional
 from typing import Union
@@ -43,9 +45,28 @@
 class AgentBuilderAssistant:
   """Agent Builder Assistant factory for creating configured instances."""
 
+  _CORE_SCHEMA_DEF_NAMES: tuple[str, ...] = (
+      "LlmAgentConfig",
+      "LoopAgentConfig",
+      "ParallelAgentConfig",
+      "SequentialAgentConfig",
+      "BaseAgentConfig",
+      "AgentRefConfig",
+      "CodeConfig",
+      "ArgumentConfig",
+      "ToolArgsConfig",
+      "google__adk__tools__tool_configs__ToolConfig",
+  )
+  _GEN_CONFIG_FIELDS: tuple[str, ...] = (
+      "temperature",
+      "topP",
+      "topK",
+      "maxOutputTokens",
+  )
+
   @staticmethod
   def create_agent(
-      model: Union[str, BaseLlm] = "gemini-2.5-flash",
+      model: Union[str, BaseLlm] = "gemini-2.5-pro",
       working_directory: Optional[str] = None,
   ) -> LlmAgent:
     """Create Agent Builder Assistant with embedded ADK AgentConfig schema.
@@ -125,28 +146,208 @@ def create_agent(
   def _load_schema() -> str:
     """Load ADK AgentConfig.json schema content and format for YAML embedding."""
 
-    # CENTRALIZED ADK AGENTCONFIG SCHEMA LOADING: Use common utility function
-    # This avoids duplication across multiple files and provides consistent
-    # ADK AgentConfig schema loading with caching and error handling.
-    schema_content = load_agent_config_schema(
-        raw_format=True,  # Get as JSON string
+    schema_dict = load_agent_config_schema(raw_format=False)
+    subset = AgentBuilderAssistant._extract_core_schema(schema_dict)
+    return AgentBuilderAssistant._build_schema_reference(subset)
+
+  @staticmethod
+  def _build_schema_reference(schema: dict[str, Any]) -> str:
+    """Create compact AgentConfig reference text for prompt embedding."""
+
+    defs: dict[str, Any] = schema.get("$defs", {})
+    top_level_fields: dict[str, Any] = schema.get("properties", {})
+    wrapper = textwrap.TextWrapper(width=78)
+    lines: list[str] = []
+
+    def add(text: str = "", indent: int = 0) -> None:
+      """Append wrapped text with indentation."""
+      if not text:
+        lines.append("")
+        return
+      indent_str = " " * indent
+      wrapper.initial_indent = indent_str
+      wrapper.subsequent_indent = indent_str
+      lines.extend(wrapper.fill(text).split("\n"))
+
+    add("ADK AgentConfig quick reference")
+    add("--------------------------------")
+
+    add()
+    add("LlmAgent (agent_class: LlmAgent)")
+    add(
+        "Required fields: name, instruction. ADK best practice is to always set"
+        " model explicitly.",
+        indent=2,
+    )
+    add("Optional fields:", indent=2)
+    add("agent_class: defaults to LlmAgent; keep for clarity.", indent=4)
+    add("description: short summary string.", indent=4)
+    add("sub_agents: list of AgentRef entries (see below).", indent=4)
+    add(
+        "before_agent_callbacks / after_agent_callbacks: list of CodeConfig "
+        "entries that run before or after the agent loop.",
+        indent=4,
+    )
+    add("model: string model id (required in practice).", indent=4)
+    add(
+        "disallow_transfer_to_parent / disallow_transfer_to_peers: booleans to "
+        "restrict automatic transfer.",
+        indent=4,
+    )
+    add(
+        "input_schema / output_schema: JSON schema objects to validate inputs "
+        "and outputs.",
+        indent=4,
+    )
+    add("output_key: name to store agent output in session context.", indent=4)
+    add(
+        "include_contents: bool; include tool/LLM contents in response.",
+        indent=4,
+    )
+    add("tools: list of ToolConfig entries (see below).", indent=4)
+    add(
+        "before_model_callbacks / after_model_callbacks: list of CodeConfig "
+        "entries around LLM calls.",
+        indent=4,
+    )
+    add(
+        "before_tool_callbacks / after_tool_callbacks: list of CodeConfig "
+        "entries around tool calls.",
+        indent=4,
+    )
+    add(
+        "generate_content_config: passes directly to google.genai "
+        "GenerateContentConfig (supporting temperature, topP, topK, "
+        "maxOutputTokens, safetySettings, responseSchema, routingConfig,"
+        " etc.).",
+        indent=4,
     )
 
-    # Format as indented code block for instruction embedding
-    #
-    # Why indentation is needed:
-    # - The ADK AgentConfig schema gets embedded into instruction templates using .format()
-    # - Proper indentation maintains readability in the final instruction
-    # - Code block markers (```) help LLMs recognize this as structured data
-    #
-    # Example final instruction format:
-    #   "Here is the ADK AgentConfig schema:
-    #   ```json
-    #     {"type": "object", "properties": {...}}
-    #   ```"
-    lines = schema_content.split("\n")
-    indented_lines = ["  " + line for line in lines]  # 2-space indent
-    return "```json\n" + "\n".join(indented_lines) + "\n  ```"
+    add()
+    add("Workflow agents (LoopAgent, ParallelAgent, SequentialAgent)")
+    add(
+        "Share BaseAgent fields: agent_class, name, description, sub_agents, "
+        "before/after_agent_callbacks. Never declare model, instruction, or "
+        "tools on workflow orchestrators.",
+        indent=2,
+    )
+    add(
+        "LoopAgent adds max_iterations (int) controlling iteration cap.",
+        indent=2,
+    )
+
+    add()
+    add("AgentRef")
+    add(
+        "Used inside sub_agents lists. Provide either config_path (string path "
+        "to another YAML file) or code (dotted Python reference) to locate the "
+        "sub-agent definition.",
+        indent=2,
+    )
+
+    add()
+    add("ToolConfig")
+    add(
+        "Items inside tools arrays. Required field name (string). For built-in "
+        "tools use the exported short name, for custom tools use the dotted "
+        "module path.",
+        indent=2,
+    )
+    add(
+        "args: optional object of additional keyword arguments. Use simple "
+        "key-value pairs (ToolArgsConfig) or structured ArgumentConfig entries "
+        "when a list is required by callbacks.",
+        indent=2,
+    )
+
+    add()
+    add("ArgumentConfig")
+    add(
+        "Represents a single argument. value is required and may be any JSON "
+        "type. name is optional (null allowed). Often used in callback args.",
+        indent=2,
+    )
+
+    add()
+    add("CodeConfig")
+    add(
+        "References Python code for callbacks or dynamic tool creation."
+        " Requires name (dotted path). args is an optional list of"
+        " ArgumentConfig items executed when invoking the function.",
+        indent=2,
+    )
+
+    add()
+    add("GenerateContentConfig highlights")
+    add(
+        "Controls LLM generation behavior. Common fields: maxOutputTokens, "
+        "temperature, topP, topK, candidateCount, responseMimeType, "
+        "responseSchema/responseJsonSchema, automaticFunctionCalling, "
+        "safetySettings, routingConfig; see Vertex AI GenAI docs for full "
+        "semantics.",
+        indent=2,
+    )
+
+    add()
+    add(
+        "All other schema definitions in AgentConfig.json remain available but "
+        "are rarely needed for typical agent setups. Refer to the source file "
+        "for exhaustive field descriptions when implementing advanced configs.",
+    )
+
+    if top_level_fields:
+      add()
+      add("Top-level AgentConfig fields (from schema)")
+      for field_name in sorted(top_level_fields):
+        description = top_level_fields[field_name].get("description", "")
+        if description:
+          add(f"{field_name}: {description}", indent=2)
+        else:
+          add(field_name, indent=2)
+
+    if defs:
+      add()
+      add("Additional schema definitions")
+      for def_name in sorted(defs):
+        description = defs[def_name].get("description", "")
+        if description:
+          add(f"{def_name}: {description}", indent=2)
+        else:
+          add(def_name, indent=2)
+
+    return "```text\n" + "\n".join(lines) + "\n```"
+
+  @staticmethod
+  def _extract_core_schema(schema: dict[str, Any]) -> dict[str, Any]:
+    """Return only the schema nodes surfaced by the assistant."""
+
+    defs = schema.get("$defs", {})
+    filtered_defs: dict[str, Any] = {}
+    for key in AgentBuilderAssistant._CORE_SCHEMA_DEF_NAMES:
+      if key in defs:
+        filtered_defs[key] = defs[key]
+
+    gen_config = defs.get("GenerateContentConfig")
+    if gen_config:
+      properties = gen_config.get("properties", {})
+      filtered_defs["GenerateContentConfig"] = {
+          "title": gen_config.get("title", "GenerateContentConfig"),
+          "description": (
+              "Common LLM generation knobs exposed by the Agent Builder."
+          ),
+          "type": "object",
+          "additionalProperties": False,
+          "properties": {
+              key: properties[key]
+              for key in AgentBuilderAssistant._GEN_CONFIG_FIELDS
+              if key in properties
+          },
+      }
+
+    return {
+        "$defs": filtered_defs,
+        "properties": schema.get("properties", {}),
+    }
 
   @staticmethod
   def _load_instruction_with_schema(

contributing/samples/adk_agent_builder_assistant/agent_builder_assistant.py

@@ -46,7 +46,7 @@ async def search_adk_source(
     max_results: Maximum number of results to return (default: 20)
     context_lines: Number of context lines to include around matches (default:
       3)
-    case_sensitive: Whether search should be case sensitive (default: False)
+    case_sensitive: Whether search should be case-sensitive (default: False)
 
   Returns:
     Dict containing search results:

contributing/samples/adk_agent_builder_assistant/tools/search_adk_source.py

@@ -66,7 +66,7 @@ async def write_config_files(
 
   Args:
     configs: Dict mapping file_path to config_content (YAML as string)
-    backup_existing: Whether to create timest   amped backup of existing files
+    backup_existing: Whether to create timestamped backup of existing files
       before overwriting (default: False, User should decide)
     create_directories: Whether to create parent directories if they don't exist
       (default: True)

contributing/samples/adk_agent_builder_assistant/tools/write_config_files.py

@@ -61,7 +61,7 @@
 
 3. **Decide whether to respond**:
    * If all the following conditions are met, try to add a comment to the
-     discussion, otherwise, do not respond:
+     discussion; otherwise, do not respond:
      - The discussion is not closed.
      - The latest comment is not from you or other agents (marked as
        "Response from XXX Agent").
@@ -102,7 +102,7 @@
     * You **should always** use the `convert_gcs_links_to_https` tool to convert
       GCS links (e.g. "gs://...") to HTTPS links.
     * **Do not** use the `convert_gcs_links_to_https` tool for non-GCS links.
-    * Make sure the citation URL is valid. Otherwise do not list this specific
+    * Make sure the citation URL is valid. Otherwise, do not list this specific
       citation.
   * Do not respond to any other discussion except the one specified by the user.
 

contributing/samples/adk_answering_agent/agent.py

@@ -128,7 +128,7 @@ def convert_gcs_to_https(gcs_uri: str) -> Optional[str]:
 
     base_url = "https://google.github.io/adk-docs/"
     if os.path.basename(path_after_docs) == "index.md":
-      # Use the directory path if it is a index file
+      # Use the directory path if it is an index file
       final_path_segment = os.path.dirname(path_after_docs)
     else:
       # Otherwise, use the file name without extension

contributing/samples/adk_answering_agent/utils.py

@@ -54,10 +54,10 @@
     ),
     instruction=f"""
       # 1. Identity
-      You are a helper bot that updates ADK docs in Github Repository {DOC_OWNER}/{DOC_REPO}
-      based on the code in the ADK Python codebase in Github Repository {CODE_OWNER}/{CODE_REPO} according to the instructions in the ADK docs issues.
+      You are a helper bot that updates ADK docs in GitHub Repository {DOC_OWNER}/{DOC_REPO}
+      based on the code in the ADK Python codebase in GitHub Repository {CODE_OWNER}/{CODE_REPO} according to the instructions in the ADK docs issues.
 
-      You are very familiar with Github, expecially how to search for files in a Github repository using git grep.
+      You are very familiar with GitHub, especially how to search for files in a GitHub repository using git grep.
 
       # 2. Responsibilities
       Your core responsibility includes:
@@ -69,18 +69,18 @@
       # 3. Workflow
       1. Always call the `clone_or_pull_repo` tool to make sure the ADK docs and codebase repos exist in the local folder {LOCAL_REPOS_DIR_PATH}/repo_name and are the latest version.
       2. Read and analyze the issue specified by user.
-        - If user only specified the issue number, call the `get_issue` tool to get the issue details, otherwise use the issue details provided by user directly.
+        - If user only specified the issue number, call the `get_issue` tool to get the issue details; otherwise, use the issue details provided by user directly.
       3. If the issue contains instructions about how to update the ADK docs, follow the instructions to update the ADK docs.
       4. Understand the doc update instructions.
         - Ignore and skip the instructions about updating API reference docs, since it will be automatically generated by the ADK team.
       5. Read the doc to update using the `read_local_git_repo_file_content` tool from the local ADK docs repo under {LOCAL_REPOS_DIR_PATH}/{DOC_REPO}.
       6. Find the related Python files in the ADK Python codebase.
-        - If the doc update instructions specify paths to the Python files, use them directly, otherwise use a list of regex search patterns to find the related Python files through the `search_local_git_repo` tool.
+        - If the doc update instructions specify paths to the Python files, use them directly; otherwise, use a list of regex search patterns to find the related Python files through the `search_local_git_repo` tool.
         - You should focus on the main ADK Python codebase, ignore the changes in tests or other auxiliary files.
         - You should find all the related Python files, not only the most relevant one.
       7. Read the specified or found Python files using the `read_local_git_repo_file_content` tool to find all the related code.
-        - You can ignore unit test files, unless you are sure that the test code is uesful to understand the related concepts.
-        - You should read all the the found files to find all the related code, unless you already know the content of the file or you are sure that the file is not related to the ADK doc.
+        - You can ignore unit test files, unless you are sure that the test code is useful to understand the related concepts.
+        - You should read all the found files to find all the related code, unless you already know the content of the file or you are sure that the file is not related to the ADK doc.
       8. Update the ADK doc file according to the doc update instructions and the related code.
         - Use active voice phrasing in your doc updates.
         - Use second person "you" form of address in your doc updates.
@@ -102,12 +102,12 @@
       - **File Paths:** Always use absolute paths when calling the tools to read files, list directories, or search the codebase.
       - **Tool Call Parallelism:** Execute multiple independent tool calls in parallel when feasible (i.e. searching the codebase).
       - **Avoid deletion:** Do not delete any existing content unless specifically directed to do so.
-      - **Explaination:** Provide concise explanations for your actions and reasoning for each step.
+      - **Explanation:** Provide concise explanations for your actions and reasoning for each step.
       - **Minimize changes:** When making updates to documentation pages, make the minimum amount of changes to achieve the communication goal. Only make changes that are necessary, and leave everything else as-is.
       - **Avoid trivial code sample changes:** Update code samples only when adding or modifying functionality. Do not reformat code samples, change variable names, or change code syntax unless you are specifically directed to make those updates.
 
       # 5. Output
-      Present the followings in an easy to read format as the final output to the user.
+      Present the following in an easy to read format as the final output to the user.
       - The actions you took and the reasoning
       - The summary of the pull request created
     """,