Skip to content

AGENTS.md

Latest commit

 

History

History
52 lines (38 loc) · 3.99 KB

AGENTS.md

File metadata and controls

52 lines (38 loc) · 3.99 KB

AI Coding Assistant Context

This document provides context for AI coding assistants (Antigravity, Gemini CLI, etc.) to understand the ADK Python project and assist with development.

ADK Knowledge, Architecture, and Style

For all matters regarding ADK development, please use the appropriate skill:

  • adk-architecture: Use this skill whenever you need to understand the architecture, event flow, or state management of the ADK system, or when designing or modifying core components and public APIs.
    • Read .agents/skills/adk-architecture/SKILL.md for full instructions.
  • adk-style: Use this skill whenever writing code, tests, or reviewing PRs for the ADK project to ensure compliance with styling and coding conventions. Also use it for committing, bug fixing, and testing rules.
    • Read .agents/skills/adk-style/SKILL.md for full instructions.
  • adk-git: Use this skill for any git operation (commit, push, pull, rebase, etc.). It provides guidelines for Conventional Commits and branch naming.
    • Read .agents/skills/adk-git/SKILL.md for full instructions.
  • adk-sample-creator: Use this skill when creating new samples demonstrating features or agent patterns, or when adding examples to subdirectories under contributing/.
    • Read .agents/skills/adk-sample-creator/SKILL.md for full instructions.
  • adk-review: Use this skill to review local changes for errors, style compliance, unintended outcomes, and to check if associated design docs, guides, samples, or tests need updates.
    • Read .agents/skills/adk-review/SKILL.md for full instructions.
  • adk-issue: Use this skill when analyzing, triaging, and resolving GitHub issues for the adk-python repository (orchestrating both triage and fix implementation). Do NOT use this skill if the "/adk-issue-analyze" command is explicitly requested.
    • Read .agents/skills/adk-issue/SKILL.md for full instructions.
  • adk-issue-analyze: Use this skill to fetch, inspect, and analyze a GitHub issue in a strictly read-only manner. Use this skill when the "/adk-issue-analyze" command is explicitly called.
    • Read .agents/skills/adk-issue-analyze/SKILL.md for full instructions.
  • adk-issue-fix: Use this skill to implement the code changes, unit tests, and documentation updates for an approved GitHub issue fix. Use this skill when the "/adk-issue-fix" command is explicitly called.
    • Read .agents/skills/adk-issue-fix/SKILL.md for full instructions.
  • adk-pr-triage: Use this skill when triaging and analyzing GitHub pull requests (PRs) to evaluate their objectives, legitimacy, value, and alignment with ADK's architectural, styling, and testing principles.
    • Read .agents/skills/adk-pr-triage/SKILL.md for full instructions.

Project Overview

The Agent Development Kit (ADK) is an open-source, code-first Python toolkit for building, evaluating, and deploying sophisticated AI agents.

Key Components

  • Agent: Blueprint defining identity, instructions, and tools.
  • Runner: Stateless execution engine that orchestrates agent execution.
  • Tool: Functions/capabilities agents can call.
  • Session: Conversation state management.
  • Memory: Long-term recall across sessions.
  • Workflow (ADK 2.0): Graph-based orchestration of complex, multi-step agent interactions.
  • BaseNode (ADK 2.0): Contract for all nodes, supporting output streaming and human-in-the-loop steps.
  • Context (ADK 2.0): Holds execution state and telemetry context mapped 1:1 to nodes.

For details on how the Runner works and the invocation lifecycle, please refer to the adk-architecture skill and the referenced documentation therein.

Project Architecture

For detailed architecture patterns, component descriptions, and core interfaces, please refer to the adk-architecture skill at .agents/skills/adk-architecture/SKILL.md.

Development Setup

The project uses uv for package management and Python 3.11+. Please refer to the adk-setup skill at .agents/skills/adk-setup/SKILL.md for detailed instructions.