Develop and extend
Guide Documentation category

Develop and extend

Understand the system, extend supported boundaries, test changes, and contribute safely.

For
Contributors, maintainers, and integration developers

Available documentation

Concept

How Agent Barn Fits Together

A map of the API, web app, agent runtimes, deployment stack, and the boundaries between them.

Concept

API Architecture and Request Boundaries

Follow the route, service, repository, tenancy, transaction, migration, and dependency-injection conventions.

Concept

Web App Architecture and Data Flow

Build App Router pages, provider boundaries, schemas, queries, mutations, loading states, and tests consistently.

Concept

Domain Events, Outbox, and Delivery

Add typed business events, transactional Outbox Messages, Event Deliveries, handlers, and safe monitoring.

Reference

Backend Code Standards

Apply repository-wide layering, HTTP, schema, authorization, style, review, and definition-of-done rules.

Guide

Testing and Verification

Select API, UI, runtime, migration, Kubernetes, and documentation checks that prove the changed contract.

How-to

Coordinate a Multi-PR Epic

Keep cross-ticket delivery state accurate without replacing feature docs, ADRs, or the issue tracker.

How-to

Write and Maintain Architecture Decisions

Capture hard-to-reverse technical choices, their trade-offs, consequences, and later supersession.

Concept

Understand the system architecture

Understand Agent Barn’s API, web app, Agent runtimes, persistence, authorization, telemetry, Domain Events, integrations, background processing, and Kubernetes deployment boundaries.

Guide

Develop against the API

Use and extend Agent Barn’s FastAPI surfaces with correct authentication, Organization and Agent scoping, layering, transactions, migrations, and PostgreSQL-backed tests.

Guide

Develop the web app

Build Agent Barn UI features with Next.js App Router, feature-local Zod contracts, shared API transport, TanStack Query cache rules, and Playwright verification.

Concept

Work with domain events

Model immutable business facts, stage them transactionally with business state, deliver them through idempotent handlers, and diagnose delivery failures.

How-to

Test a change

Choose the smallest reliable test surface for an Agent Barn change, then verify API, database, UI, runtime, Kubernetes, and monitoring contracts as required.

How-to

Add an integration

Extend Agent Barn with an external provider across credential validation, encrypted persistence, runtime materialization, Skills, web app configuration, and end-to-end verification.

How-to

Add a communication platform

Add a communication platform across typed configuration, encrypted credentials, lifecycle orchestration, runtime builders, message access controls, telemetry, health, webhooks, and onboarding.

How-to

Contribute templates and Skills

Contribute source-controlled Platform Templates and built-in aai-cli Skills while preserving bootstrap, versioning, credential, and review contracts.

Documentation