PublishedDocs / Augments

Augments

Understand how built-in and custom augments add capabilities to an Auggy agent.

One runtime module

An augment is a runtime module that adds a coherent capability to an agent. It can contribute one surface, such as a transport, or keep related tools, context, memory, policy, storage, and operator controls together.

Composition modeltext

Auggy kernel
  + webTransport       -> chat, console, health
  + layeredMemory      -> peer memory, tools, context
  + your support       -> typed tools, integration code

Add or build

Add installs and configures an existing built-in. Build creates a custom augment whose TypeScript belongs to your project.

What an augment can contribute

Surface	Purpose
Tools	Typed operations the model can choose during a turn.
Context and memory	Turn context, durable providers, and retrieval or write behavior.
Lifecycle	Boot, shutdown, turn, idle, and background-work hooks.
Transports	Inbound and outbound channels such as web chat or Telegram.
Policy and operations	Tool constraints, health, admin information, and operator actions.

A capability does not need every surface. Keep the augment as small as the operation requires, and add a skill only when tool descriptions are not enough to guide model behavior.

Built-in and custom ownership

Kind	Project owns	Implementation
Built-in	agent.yaml entry, augment.yaml config, and an installed skill snapshot when provided	Installed auggy package under `node_modules`/auggy/src
Custom	augment.yaml, local TypeScript, tests, and optional source skill	augments/<name>/ in the agent project

agent.yaml lists enabled augment IDs in boot order. Built-in config lives in augments/<id>/augment.yaml. Skills are copied into skills/<id>/ so the project can inspect and adapt its installed guidance.

Choose an augment

Core runtime

The compact chat-ready set installed by `auggy create`. Each piece has a narrow runtime responsibility.

File MemoryCoreLoad identity and creator-approved global behavior from files.memorycontext FilesystemCoreGive the agent named, operator-controlled file mounts and a durable workspace.toolscontext Web TransportCoreServe AG-UI turns, Console, health checks, and runtime discovery.transportconsolehealth Web FetchCoreFetch public URLs and return readable HTML text or JSON to the model.tool Turn ControlCoreLet the agent stop a turn and ask one answerable question.toolturn status

Memory and knowledge

Add durable per-person facts or controlled access to operator-maintained information.

Layered MemoryStablePersist peer-scoped episodic memory in SQLite with search, write, list, and forget tools, explicit write outcomes, and stable-identity requirements.memorytoolscontext KnowledgeStableExpose listed local documents and remote knowledge endpoints on demand.toolcontext

Integrations

Connect the runtime to external tool providers and communication channels.

MCPStableImport tools from configured local or remote MCP servers.toolslifecycle AgentMailStableSend, receive, reply, and forward under policy with durable polling/WebSocket/Svix inbound, human review, and recovery.toolstransportroutesadminaudit TelegramStableRun text turns through a Telegram bot using polling or webhooks.transport

Identity and operations

Recognize returning visitors and move important events outside the active conversation.

Visitor AuthStableVerify email ownership and issue a durable recognized-visitor identity.toolroutesidentity NotifyStableSend outbound alerts to named file, webhook, Telegram, or AgentMail destinations.tooladapters

Preview

Useful capabilities with security, deployment, or operational edges that still require deliberate setup.

BashPreviewRun allowed host commands or operator-authored scripts.tools BudgetsPreviewGate turns using per-thread, rolling, daily, and spend limits.turn gatecontextadmin LinkPreviewExchange authenticated text requests with configured A2A peers.toolstransport

Skills are runtime infrastructure

The skills loader is mounted by Auggy and is not a catalog choice. Individual augments may ship skill folders that the loader exposes on demand.

Choose the next path

Goal	Guide
Install a supported capability	Add an augment
Author project-specific behavior	Build an augment
Expose model-callable operations	Tools
Teach a non-obvious workflow	Skills

Add an augmentInstall layeredMemory, inspect what the CLI adds, and verify peer-scoped memory in Console.Build an augmentBuild one project-specific typed tool inside a custom augment.Add toolsExpose typed actions the model can select during a turn and your code executes.SkillsTeach the model when and how to use an augment without loading every instruction into context on every turn.