Entwicklungsrichtlinien

Dieses Dokument bietet umfassende Richtlinien für Entwickler, die zu ADK-Rust beitragen. Das Befolgen dieser Standards gewährleistet Codequalität, Konsistenz und Wartbarkeit im gesamten Projekt.

Inhaltsverzeichnis

• Erste Schritte
• Projektstruktur
• Code-Stil
• Fehlerbehandlung
• Async-Muster
• Tests
• Dokumentation
• Pull-Request-Prozess
• Häufige Aufgaben

Erste Schritte

Voraussetzungen

• Rust: 1.95.0 oder höher (Edition 2024, prüfen mit rustc --version)
• Cargo: Neueste stabile Version
• Git: Für die Versionskontrolle
• sccache (empfohlen): Kompilierungscache, der die Neuübersetzungszeiten um ~70% reduziert

Einrichten Ihrer Umgebung

# Clone the repository
git clone https://github.com/zavora-ai/adk-rust.git
cd adk-rust

# Option A: Nix/devenv (reproducible — identical on Linux, macOS, CI)
devenv shell

# Option B: Setup script (installs sccache, cmake, etc.)
./scripts/setup-dev.sh

# Option C: Manual
cargo build

# Install cargo-nextest (parallel test runner, ~10x faster)
curl -LsSf https://get.nexte.st/latest/mac | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin

# Run all tests
cargo nextest run --workspace

# Check for lints
cargo clippy --all-targets --all-features

# Format code
cargo fmt --all

Umgebungsvariablen

Zum Ausführen von Beispielen und Tests, die API-Schlüssel erfordern:

# Gemini (default provider)
export GOOGLE_API_KEY="your-api-key"

# OpenAI (optional)
export OPENAI_API_KEY="your-api-key"

# Anthropic (optional)
export ANTHROPIC_API_KEY="your-api-key"

Projektstruktur

ADK-Rust ist als Cargo-Workspace mit mehreren Crates organisiert:

adk-rust/
├── adk-core/       # Foundational traits and types (Agent, Tool, Llm, Event)
├── adk-telemetry/  # OpenTelemetry integration
├── adk-model/      # LLM providers (Gemini, OpenAI, Anthropic)
├── adk-tool/       # Tool system (FunctionTool, MCP, AgentTool)
├── adk-session/    # Session management (in-memory, SQLite)
├── adk-artifact/   # Binary artifact storage
├── adk-memory/     # Long-term memory with search
├── adk-agent/      # Agent implementations (LlmAgent, workflow agents)
├── adk-runner/     # Execution runtime
├── adk-server/     # REST API and A2A protocol
├── adk-cli/        # Command-line launcher
├── adk-realtime/   # Voice/audio streaming agents
├── adk-graph/      # LangGraph-style workflows
├── adk-browser/    # Browser automation tools
├── adk-eval/       # Agent evaluation framework
├── adk-rust/       # Umbrella crate (re-exports all)
└── examples/       # Working examples

Crate-Abhängigkeiten

Crates müssen in der Reihenfolge ihrer Abhängigkeiten veröffentlicht werden:

1. adk-core (keine internen Abhängigkeiten)
2. adk-telemetry
3. adk-model
4. adk-tool
5. adk-session
6. adk-artifact
7. adk-memory
8. adk-agent
9. adk-runner
10. adk-server
11. adk-cli
12. adk-realtime
13. adk-graph
14. adk-browser
15. adk-eval
16. adk-rust (umbrella)

Code-Stil

Allgemeine Grundsätze

1. Klarheit vor Cleverness: Schreiben Sie Code, der leicht zu lesen und zu verstehen ist
2. Explizit vor implizit: Bevorzugen Sie explizite Typen und Fehlerbehandlung
3. Kleine Funktionen: Halten Sie Funktionen fokussiert und nach Möglichkeit unter 50 Zeilen
4. Aussagekräftige Namen: Verwenden Sie beschreibende Variablen- und Funktionsnamen

Formatierung

Verwenden Sie rustfmt mit den Standardeinstellungen:

cargo fmt --all

Die CI-Pipeline erzwingt die Formatierung. Führen Sie immer cargo fmt aus, bevor Sie committen.

Namenskonventionen

Imports

Organisiere Imports in dieser Reihenfolge:

// 1. Standard library
use std::collections::HashMap;
use std::sync::Arc;

// 2. External crates
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use tokio::sync::RwLock;

// 3. Internal crates (adk-*)
use adk_core::{Agent, Event, Result};

// 4. Local modules
use crate::config::Config;
use super::utils;

Clippy

Der gesamte Code muss ohne Warnungen clippy bestehen:

cargo clippy --all-targets --all-features

Behebe clippy-Warnungen, anstatt sie zu unterdrücken. Wenn eine Unterdrückung notwendig ist, dokumentiere warum:

#[allow(clippy::too_many_arguments)]
// Builder pattern requires many parameters; refactoring would hurt usability
fn complex_builder(...) { }

Fehlerbehandlung

Strukturierter Fehler-Envelope

AdkError ist ein strukturierter Fehlertyp mit Komponente (wo), Kategorie (welche Art), Code (maschinenlesbarer Schlüssel), Nachricht (menschlicher Text), Retry-Hinweis und optionalen Details:

use adk_core::{AdkError, ErrorComponent, ErrorCategory, Result};

// Return Result<T> (aliased to Result<T, AdkError>)
pub async fn my_function() -> Result<String> {
    let data = fetch_data().await?;

    if data.is_empty() {
        return Err(AdkError::new(
            ErrorComponent::Tool,
            ErrorCategory::NotFound,
            "tool.data.not_found",
            "No data found for the given query",
        ));
    }

    Ok(data)
}

Komponente und Kategorie auswählen

ErrorComponent gibt an, wo der Fehler aufgetreten ist (das Ursprungs-Subsystem, nicht die Trait-Grenze, über die er sichtbar wird):

ErrorCategory klassifiziert, was schiefgelaufen ist:

Komfortable Konstruktoren

Für gängige Muster:

// Structured (preferred for new code)
AdkError::not_found(ErrorComponent::Session, "session.not_found", "Session xyz not found")
AdkError::rate_limited(ErrorComponent::Model, "model.openai.rate_limited", "Too many requests")
AdkError::unauthorized(ErrorComponent::Auth, "auth.token_expired", "Bearer token expired")
AdkError::timeout(ErrorComponent::Tool, "tool.execution_timeout", "Tool timed out after 30s")

// Backward-compatible (for migration — produces .legacy codes)
AdkError::tool("No data found")
AdkError::model("Provider returned 500")
AdkError::session("Session not found")

Builder API

Strukturierte Metadaten für reichhaltigeren Fehlerkontext anhängen:

let err = AdkError::new(
    ErrorComponent::Model,
    ErrorCategory::RateLimited,
    "model.openai.rate_limited",
    "OpenAI rate limit exceeded",
)
.with_provider("openai")
.with_upstream_status(429)
.with_request_id("req-abc123")
.with_retry(RetryHint {
    should_retry: true,
    retry_after_ms: Some(5000),
    max_attempts: Some(3),
});

Wiederholungs-Hinweise

Wiederholbare Kategorien (RateLimited, Unavailable, Timeout) setzen automatisch should_retry: true. Prüfe die Wiederholbarkeit mit err.is_retryable(), das retry.should_retry als Single Source of Truth verwendet:

if err.is_retryable() {
    if let Some(delay) = err.retry.retry_after() {
        tokio::time::sleep(delay).await;
    }
    // retry the operation
}

Kategorie-Prüfungen

err.is_retryable()    // retry.should_retry (RateLimited, Unavailable, Timeout by default)
err.is_not_found()    // category == NotFound
err.is_unauthorized() // category == Unauthorized
err.is_rate_limited() // category == RateLimited
err.is_timeout()      // category == Timeout

Komponenten-Prüfungen (Abwärtskompatibilität)

err.is_model()   // component == Model
err.is_tool()    // component == Tool
err.is_session() // component == Session
err.is_config()  // code == "config.legacy" (temporary bridge)

HTTP-Status und Problem-JSON

AdkError bildet direkt auf HTTP-Antworten ab:

let status = err.http_status_code(); // u16 based on category
let body = err.to_problem_json();    // structured JSON error body
// body: { "error": { "code", "message", "component", "category", "requestId", "retryAfter", ... } }

Crate-lokale Fehler mit From-Impls

Crates mit domänenspezifischen Fehlern implementieren From<CrateLocalError> for AdkError:

// In your crate
#[derive(Debug, thiserror::Error)]
pub enum MyToolError {
    #[error("connection failed: {0}")]
    ConnectionFailed(String),
    #[error("timeout after {0}ms")]
    Timeout(u64),
}

impl From<MyToolError> for AdkError {
    fn from(err: MyToolError) -> Self {
        let (category, code) = match &err {
            MyToolError::ConnectionFailed(_) => (ErrorCategory::Unavailable, "mytool.connection"),
            MyToolError::Timeout(_) => (ErrorCategory::Timeout, "mytool.timeout"),
        };
        AdkError::new(ErrorComponent::Tool, category, code, err.to_string())
            .with_source(err)
    }
}

Keine pauschalen From-Impls

std::io::Error und serde_json::Error überschreiten zu viele Subsystemgrenzen für eine einzige pauschale Konvertierung. Verwende explizite map_err mit der korrekten Komponente:

// Good: explicit component and category
let data = std::fs::read_to_string(path)
    .map_err(|e| AdkError::new(
        ErrorComponent::Session,
        ErrorCategory::Internal,
        "session.io_read",
        format!("failed to read session file: {e}"),
    ).with_source(e))?;

// Good: for quick migration
let data = serde_json::from_str(&raw)
    .map_err(|e| AdkError::session(format!("JSON parse failed: {e}")))?;

Fehlermeldungen

Schreibe klare, handlungsorientierte Fehlermeldungen:

// Good: specific and actionable
AdkError::new(
    ErrorComponent::Model,
    ErrorCategory::InvalidInput,
    "model.missing_api_key",
    "API key not found. Set GOOGLE_API_KEY environment variable.",
)

// Bad: vague
AdkError::model("Invalid config")

Keine Panics im Bibliothekscode

Bibliotheks-Crates dürfen bei wiederherstellbaren Fehlern niemals panic auslösen. Vermeide unwrap(), expect() und panic!() in src/-Code (Testcode ist ausgenommen).

RwLock / Mutex: Verwende sanfte Degradation statt unwrap(). Ein vergifteter Lock bedeutet, dass ein anderer Thread panic ausgelöst hat — auch den aktuellen Thread abstürzen zu lassen, verschlimmert die Lage.

// Bad: panics if lock is poisoned
let state = self.state.write().unwrap();

// Good: log and return a safe default
let Ok(state) = self.state.write() else {
    tracing::error!("state lock poisoned — returning default");
    return Default::default();
};

// Good: recover through the poison (data may be stale but won't crash)
let state = self.state.read().unwrap_or_else(|e| e.into_inner());

Konstruktoren: Gib Result zurück, wenn die Initialisierung fehlschlagen kann (z. B. beim Verbinden mit externen Diensten).

// Bad: panics if Docker is not running
pub fn new(config: Config) -> Self {
    let client = connect().expect("connection failed");
    Self { client }
}

// Good: caller decides how to handle the failure
pub fn new(config: Config) -> Result<Self, MyError> {
    let client = connect().map_err(|e| MyError::Init(e.to_string()))?;
    Ok(Self { client })
}

Builder-Methoden: Verwende if let Some statt expect() für Arc::get_mut():

// Bad: panics if Arc is shared
pub fn add_callback(mut self, cb: Callback) -> Self {
    Arc::get_mut(&mut self.callbacks).expect("not shared").push(cb);
    self
}

// Good: silent no-op (builder pattern guarantees single ownership)
pub fn add_callback(mut self, cb: Callback) -> Self {
    if let Some(callbacks) = Arc::get_mut(&mut self.callbacks) {
        callbacks.push(cb);
    }
    self
}

Async-Muster

Tokio verwenden

Aller async-Code verwendet die Tokio-Runtime:

use tokio::sync::{Mutex, RwLock};

// Prefer RwLock for read-heavy data
let state: Arc<RwLock<State>> = Arc::new(RwLock::new(State::default()));

// Use Mutex for write-heavy or simple cases
let counter: Arc<Mutex<u32>> = Arc::new(Mutex::new(0));

Tokio-Feature-Konvention

Bibliotheks-Crates (adk-*) müssen nur die minimalen tokio-Features deklarieren, die sie tatsächlich verwenden:

# Library crates — minimal features
tokio = { workspace = true, features = ["rt", "sync", "time"] }

# Binary crates only (adk-cli, examples) — full is acceptable
tokio = { workspace = true, features = ["full"] }

Verwende niemals features = ["full"] in einem Bibliotheks-Crate. Das zwingt alle nachgelagerten Verbraucher dazu, jedes tokio-Subsystem zu kompilieren, unabhängig davon, ob sie es brauchen oder nicht.

Async-Traits

Verwende async_trait für async-Trait-Methoden:

use async_trait::async_trait;

#[async_trait]
pub trait MyTrait: Send + Sync {
    async fn do_work(&self) -> Result<()>;
}

Streaming

Verwende EventStream für Streaming-Antworten:

use adk_core::EventStream;
use async_stream::stream;
use futures::Stream;

fn create_stream() -> EventStream {
    let s = stream! {
        yield Ok(Event::new("inv-1"));
        yield Ok(Event::new("inv-2"));
    };
    Box::pin(s)
}

Thread-Sicherheit

Alle öffentlichen Typen müssen Send + Sync sein:

// Good: Thread-safe
pub struct MyAgent {
    name: String,
    tools: Vec<Arc<dyn Tool>>,  // Arc for shared ownership
}

// Verify with compile-time checks
fn assert_send_sync<T: Send + Sync>() {}
fn _check() {
    assert_send_sync::<MyAgent>();
}

Testen

Test-Runner

ADK-Rust verwendet cargo-nextest für die Testausführung. Nextest führt jedes Test-Binary in einem separaten Prozess mit paralleler Planung aus und bietet auf diesem Workspace eine etwa 10-fache Beschleunigung gegenüber cargo test.

# Install (one-time)
curl -LsSf https://get.nexte.st/latest/mac | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin

# Or via devenv (included automatically)
devenv shell

Die Konfiguration befindet sich in .config/nextest.toml mit zwei Profilen:

• default — lokale Entwicklung (fail-fast, keine Wiederholungen)
• ci — CI-Läufe (Wiederholungen für instabile Tests, Warnungen für langsame Tests)

Testorganisation

crate/
├── src/
│   ├── lib.rs          # Unit tests at bottom of file
│   └── module.rs       # Module-specific tests
└── tests/
    └── integration.rs  # Integration tests

Unit-Tests

Platziere Unit-Tests in derselben Datei wie der Code:

pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_add() {
        assert_eq!(add(2, 3), 5);
    }

    #[tokio::test]
    async fn test_async_function() {
        let result = async_function().await;
        assert!(result.is_ok());
    }
}

Integrationstests

Platziere sie im Verzeichnis tests/:

// tests/integration_test.rs
use adk_core::*;

#[tokio::test]
async fn test_full_workflow() {
    // Setup
    let service = InMemorySessionService::new();

    // Execute
    let session = service.create(request).await.unwrap();

    // Assert
    assert_eq!(session.id(), "test-session");
}

Mock-Tests

Verwende MockLlm zum Testen ohne API-Aufrufe:

use adk_model::MockLlm;

#[tokio::test]
async fn test_agent_with_mock() {
    let mock = MockLlm::new(vec![
        "First response".to_string(),
        "Second response".to_string(),
    ]);

    let agent = LlmAgentBuilder::new("test")
        .model(Arc::new(mock))
        .build()
        .unwrap();

    // Test agent behavior
}

Testbefehle

# Run all tests (nextest — parallel, fast)
cargo nextest run --workspace

# Run specific crate tests
cargo nextest run -p adk-core

# Run with CI profile (retries flaky tests)
cargo nextest run --workspace --profile ci

# Run doctests (nextest doesn't run these — use cargo test)
cargo test --workspace --doc

# Run ignored tests (require API keys)
cargo nextest run --workspace -- --run-ignored

# Run with output (nextest shows output for failing tests by default)
cargo nextest run --workspace --no-capture

# Devenv shortcuts
devenv shell ws-test          # nextest, default profile
devenv shell ws-test-ci       # nextest, CI profile
devenv shell ws-test-slow     # cargo test fallback (includes doctests)

Dokumentation

Doc-Kommentare

Verwende /// für öffentliche Elemente:

/// Creates a new LLM agent with the specified configuration.
///
/// # Arguments
///
/// * `name` - A unique identifier for this agent
/// * `model` - The LLM provider to use for reasoning
///
/// # Examples
///
/// ```rust
/// use adk_agent::LlmAgentBuilder;
///
/// let agent = LlmAgentBuilder::new("assistant")
///     .model(Arc::new(model))
///     .build()?;
/// ```
///
/// # Errors
///
/// Returns an error with component `Agent` if the model is not set.
pub fn new(name: impl Into<String>) -> Self {
    // ...
}

Modul-Dokumentation

Füge modulweite Doku oben in lib.rs hinzu:

//! # adk-core
//!
//! Core types and traits for ADK-Rust.
//!
//! ## Overview
//!
//! This crate provides the foundational types...

README-Dateien

Jedes Crate sollte eine README.md haben mit:

1. Kurzer Beschreibung
2. Installationsanweisungen
3. Kurzem Beispiel
4. Link zur vollständigen Dokumentation

Dokumentationstests

Stelle sicher, dass Doku-Beispiele kompilieren:

cargo test --doc --all

Pull-Request-Prozess

Vor dem Einreichen

1. Die vollständige Test-Suite ausführen:

   cargo nextest run --workspace

2. clippy ausführen:

   cargo clippy --all-targets --all-features

3. Code formatieren:

   cargo fmt --all

4. Dokumentation aktualisieren, wenn öffentliche API hinzugefügt/geändert werden

5. Tests hinzufügen für neue Funktionalität

PR-Richtlinien

• Titel: Klare, knappe Beschreibung der Änderung
• Beschreibung: Erkläre was und warum (nicht wie)
• Größe: Halte PRs fokussiert; große Änderungen aufteilen
• Tests: Tests für neue Funktionalität einschließen
• Breaking Changes: In der Beschreibung klar dokumentieren

Commit-Meldungen

Befolge Conventional Commits:

feat: add OpenAI streaming support
fix: correct tool parameter validation
docs: update quickstart guide
refactor: simplify session state management
test: add integration tests for A2A protocol

Projekt-Scaffolding

Verwende cargo adk new mit dem Composable Template System, um neue Projekte zu scaffolden. Das integrierte Registry bietet 12 Vorlagen, 9 Add-ons und 5 Enterprise-Muster:

# Basic agent (default)
cargo adk new my-agent

# Agent with tools and Docker support
cargo adk new my-agent --template tools --addon docker

# A2A protocol agent with CI and telemetry
cargo adk new my-agent --template a2a --addon ci --addon telemetry

# Graph workflow with enterprise observability
cargo adk new my-agent --template graph --addon telemetry --addon docker --addon ci

Das --addon-Flag ist komponierbar — kombiniere jede Basisvorlage mit beliebig vielen Add-ons. Siehe die Dokumentation zu Composable Templates für die vollständige Liste der Vorlagen, Add-ons und Enterprise-Muster.

Häufige Aufgaben

Hinzufügen eines neuen Tools

1. Tool erstellen:

use adk_core::{Tool, ToolContext, Result};
use async_trait::async_trait;
use serde_json::Value;

pub struct MyTool {
    // fields
}

#[async_trait]
impl Tool for MyTool {
    fn name(&self) -> &str {
        "my_tool"
    }

    fn description(&self) -> &str {
        "Does something useful"
    }

    fn parameters_schema(&self) -> Option<Value> {
        Some(serde_json::json!({
            "type": "object",
            "properties": {
                "input": { "type": "string" }
            },
            "required": ["input"]
        }))
    }

    async fn execute(&self, ctx: Arc<dyn ToolContext>, args: Value) -> Result<Value> {
        let input = args["input"].as_str().unwrap_or_default();
        Ok(serde_json::json!({ "result": input }))
    }
}

1. Zum Agenten hinzufügen:

let agent = LlmAgentBuilder::new("agent")
    .model(model)
    .tool(Arc::new(MyTool::new()))
    .build()?;

Hinzufügen eines neuen Modellanbieters

1. Modul erstellen in adk-model/src/:

// adk-model/src/mymodel/mod.rs
mod client;
pub use client::MyModelClient;

1. Das Llm-Trait implementieren:

use adk_core::{Llm, LlmRequest, LlmResponse, LlmResponseStream, Result};

pub struct MyModelClient {
    api_key: String,
}

#[async_trait]
impl Llm for MyModelClient {
    fn name(&self) -> &str {
        "my-model"
    }

    async fn generate_content(
        &self,
        request: LlmRequest,
        stream: bool,
    ) -> Result<LlmResponseStream> {
        // Implementation
    }
}

1. Feature-Flag hinzufügen in adk-model/Cargo.toml:

[features]
mymodel = ["dep:mymodel-sdk"]

1. Bedingt exportieren:

#[cfg(feature = "mymodel")]
pub mod mymodel;
#[cfg(feature = "mymodel")]
pub use mymodel::MyModelClient;

Hinzufügen eines neuen Agententyps

1. Modul erstellen in adk-agent/src/:

// adk-agent/src/my_agent.rs
use adk_core::{Agent, EventStream, InvocationContext, Result};
use async_trait::async_trait;

pub struct MyAgent {
    name: String,
}

#[async_trait]
impl Agent for MyAgent {
    fn name(&self) -> &str {
        &self.name
    }

    fn description(&self) -> &str {
        "My custom agent"
    }

    async fn run(&self, ctx: Arc<dyn InvocationContext>) -> Result<EventStream> {
        // Implementation
    }
}

1. Exportieren in adk-agent/src/lib.rs:

mod my_agent;
pub use my_agent::MyAgent;

Tipps zur Fehlersuche

1. Tracing aktivieren:

   adk_telemetry::init_telemetry();

2. Ereignisse inspizieren:

   while let Some(event) = stream.next().await {
       eprintln!("Event: {:?}", event);
   }

3. RUST_LOG verwenden:

   RUST_LOG=debug cargo run --example myexample

---

Vorherig: ← Zugriffskontrolle

Fragen? Öffne ein Issue auf GitHub.