Documentation Index
Documentation Index
Getting Started
Architecture & Core Concepts
- Architecture Overview — Complete system architecture and design principles
Features & Capabilities
Planning & Orchestration
- Planning Engine — Multi-step task planning and execution
- Human-in-the-Loop — Approval workflows and human oversight
- Agent Communication — Inter-agent messaging and coordination
Safety & Security
- Guardrails System — Two-phase guardrail dispatch, built-in packs (PII, ML classifiers, topicality, code safety, grounding), and folder-level filesystem permissions
- Safety Primitives — Circuit breakers, cost guards, stuck detection, and tool execution guards
Memory & Storage
- Cognitive Memory System — Personality-modulated memory with Ebbinghaus decay, Baddeley's working memory, spreading activation, and HEXACO-driven encoding
- RAG Memory Configuration — Vector storage and retrieval setup
- SQL Storage Quickstart — Database integration guide
- Client-Side Storage — Browser-based persistence
- Immutable Agents — Sealing lifecycle, toolset pinning, secret rotation, and soft-forget
- Provenance & Immutability — Sealed storage policy, signed ledger, and anchoring
AI & LLM
- Structured Output — JSON schema validation and structured generation
- Evaluation Framework — Testing, scoring, and quality assurance
- Cost Optimization — Token usage and API cost management
Extensions & Customization
- RFC Extension Standards — Extension development guidelines
- Recursive Self-Building Agents — Advanced agent patterns
- Skills (SKILL.md) — Prompt modules loaded from directories/registries
Platform & Infrastructure
- Platform Support — Supported environments and requirements
- Observability (OpenTelemetry) — Tracing, metrics, and log correlation/export (opt-in)
- Logging (Pino + OpenTelemetry) — Structured logs, trace correlation, and OTEL LogRecord export (opt-in)
Ecosystem
API Reference
- TypeDoc API — Auto-generated API documentation
Quick Links
| Resource | Link |
|---|---|
| Website | agentos.sh |
| GitHub | framersai/agentos |
| npm | @framers/agentos |
| Issues | GitHub Issues |
| Discussions | GitHub Discussions |
How to Use This Documentation
- New to AgentOS? Start with the README for installation and basic usage
- Understanding the system? Read the Architecture Overview
- Building features? Check the relevant feature guide (Planning, HITL, Guardrails, etc.)
- API details? Browse the TypeDoc API Reference
- Troubleshooting? See Platform Support