Architecture Overview¶
SynthOrg is organized as a modular, protocol-driven framework. Every major subsystem is defined by a protocol interface, enabling pluggable strategy implementations.
Module Map¶
Module Responsibilities¶
| Module | Purpose |
|---|---|
| core | Shared domain models: Agent, Task, Role, Company, Project, Approval, Artifact |
| client | Client simulation: profiles, requirements, feedback, AI/human/hybrid clients, requirement generators, feedback strategies, pool strategies |
| engine | Agent orchestration: execution loops (ReAct, Plan-and-Execute), task decomposition, routing, assignment, parallel execution, recovery, shutdown |
| engine.intake | Intake processing: ClientRequest lifecycle, IntakeStrategy protocol, validation |
| engine.review | Review pipeline: ReviewStage protocol, multi-stage review orchestration, verdict tracking |
| providers | LLM provider abstraction: LiteLLM adapter, capability matching, routing strategies (5), retry + rate limiting |
| communication | Inter-agent messaging: bus, dispatcher, delegation, loop prevention, conflict resolution (4 strategies), meeting protocols (3) |
| memory | Persistent agent memory: retrieval pipeline (ranking, filtering, injection), shared org memory, consolidation/archival |
| security | Security subsystem: SecOps agent, rule engine (soft-allow/hard-deny), output scanner, progressive trust (4 strategies), autonomy levels, timeout policies |
| budget | Cost management: cost tracking, budget enforcement (pre-flight/in-flight), auto-downgrade, quota/subscription, CFO optimizer, spending reports |
| hr | Agent lifecycle: hiring, firing, onboarding, offboarding, registry, performance tracking, promotion/demotion |
| tools | Tool system: registry, built-in tools (file system, git, sandbox, code runner), MCP bridge, role-based access |
| api | REST + WebSocket API: Litestar controllers, JWT + API key + WS ticket auth, guards, channels, RFC 9457 structured error responses |
| config | Company configuration: YAML schema, loader, validation, defaults |
| templates | Pre-built company templates: personality presets, template builder |
| persistence | Operational data: pluggable backend protocol, SQLite implementation |
| observability | Structured logging: structlog, event constants, correlation tracking, log sinks |
Design Principles¶
-
Protocol-driven: every major subsystem defines a protocol interface. Concrete strategies implement the protocol. New strategies can be added without modifying existing code.
-
Immutability: configuration and identity use frozen Pydantic models. Runtime state evolves via
model_copy(update=...). No in-place mutation. -
Fail-closed security: the security rule engine defaults to deny. Actions must be explicitly allowed by matching rules.
-
Structured concurrency: async operations use
asyncio.TaskGroupfor fan-out/fan-in. No barecreate_taskcalls. -
Provider-agnostic: all LLM interactions go through the provider abstraction. No vendor-specific code in business logic.
-
Observable by default: every module uses structured logging with domain-specific event constants. Correlation IDs track requests across agent boundaries.
Further Reading¶
- Design Specification: full design spec split into multiple focused pages
- Tech Stack: technology choices and engineering conventions
- Decision Log: all design decisions, organized by domain
- REST API: REST + WebSocket API reference (Scalar/OpenAPI)
- Library Reference: auto-generated from source code