---
name: agent-setup
description: >-
  Set up @adonis-agora/agent in an AdonisJS app: node ace configure @adonis-agora/agent,
  defineConfig in config/agent.ts (model via aiSdkModel from @adonis-agora/agent/ai-sdk,
  stores.lucid()/stores.memory(), quota: { limits }, pricingStores +
  seedModelPrices + estimateCost, tokenSinks.redis / tokenSinks.lucid multi-replica SSE sinks,
  AuthActorResolver identity seam), auto-created agent tables vs the published migration,
  the cost fold (null vs $0.00), and route mounting under config path. Use for "set up
  the agent", "config/agent.ts", "agent tables / migration", "costUsd is null or zero",
  "quota not enforced", "401 on every agent route".
metadata:
  type: core
  library: "@adonis-agora/agent"
  library_version: "0.25.2"
  framework: adonisjs
sources:
  - "DavideCarvalho/adonis-agent:packages/adonis/docs/getting-started.mdx"
  - "DavideCarvalho/adonis-agent:packages/adonis/docs/config-reference.mdx"
  - "DavideCarvalho/adonis-agent:packages/adonis/src/define_config.ts"
  - "DavideCarvalho/adonis-agent:packages/adonis/src/stores/factory.ts"
  - "DavideCarvalho/adonis-agent:packages/adonis/docs/react.mdx"
  - "DavideCarvalho/adonis-agent:packages/adonis/src/react/index.ts"
  - "DavideCarvalho/adonis-agent:packages/adonis/docs/channels.mdx"
---

# Setting up @adonis-agora/agent

`@adonis-agora/agent` is a governed AI agent module for AdonisJS: one `defineConfig`
call in `config/agent.ts` wires a provider-agnostic agent (the loop by default, or an
`engine` that runs turns instead), persistence, budgeting,
and the `/agent/*` HTTP+SSE routes. Either `model` (the loop runs the turns) or
`engine` (something else does) is required — everything else ships with a default that
this skill walks through.

## Setup

Install and let the configure hook wire everything:

```bash
pnpm add @adonis-agora/agent
node ace configure @adonis-agora/agent
```

`configure` registers `@adonis-agora/agent/agent_provider` and
`@adonis-agora/agent/dashboard_provider` in `adonisrc.ts`, registers the Assembler init
hook that generates the typed `app/agent_tools` barrel, publishes `config/agent.ts`,
`config/mcp.ts`, and five migrations: three for the agent tables (the base tables plus two
forward-only action-proposal upgrades) and two Postgres-only ones (the pgvector RAG chunk
table and the document-tree tables — delete the ones you don't use). Then add the model peer and write your config:

```bash
pnpm add ai zod @ai-sdk/openai
```

```ts
// config/agent.ts
import { defineConfig, stores, AuthActorResolver } from '@adonis-agora/agent'
import { aiSdkModel } from '@adonis-agora/agent/ai-sdk'
import { openai } from '@ai-sdk/openai'

export default defineConfig({
  // A lazy thunk keeps the provider SDK peer imported only at boot.
  model: () => aiSdkModel(openai('gpt-4o-mini')),

  store: 'lucid',
  stores: {
    memory: stores.memory(), // single-process; tests and scratch apps
    lucid: stores.lucid(),   // persists to SQL via @adonisjs/lucid
  },

  // Identity. Omitted → endpoints PUBLIC, one anonymous actor per browser (HttpOnly cookie).
  // This line requires login instead (ctx.auth.user; 401 without).
  actorResolver: new AuthActorResolver(),

  defaultAgent: {
    systemPrompt: 'You are a helpful assistant for our app.',
  },
})
```

Run the published migrations for the agent tables (`agent_action_proposal`,
`agent_thread`, `agent_message`, `agent_tool_call`, `agent_token_usage`,
`agent_model_pricing`, `agent_run`, `agent_queued_message`, `agent_confirm_token`, `agent_genui_call`, plus the
`agent_stream_frame` buffer and the text channels' `agent_channel_state`):

```bash
node ace migration:run
```

You can skip it: the Lucid store provisions and repairs its own tables as the app starts
(`autoCreateTables` defaults to true; an ace command or a hand-built store does it on first
use), so an upgrade that adds a column needs no app migration. The published migrations
delegate to the same `createAgentTables` helper, so the two schemas can never drift.
Only with `autoCreateTables: false` does an upgrade need a migration that calls
`createAgentTables` again.

Source: `packages/adonis/docs/getting-started.mdx`,
`packages/adonis/docs/stores/lucid.mdx`.

## Core patterns

### Pattern 1 — set a budget with `quota: { limits }`

Budgets are **opt-in**: omitting `quota` means usage is reported (`GET /agent/quota`) but
never enforced. With limits, a send while a window is exhausted is refused with `429`
`{ code: 'quota_exceeded', period }` before the turn starts — no tokens spent.

```ts
export default defineConfig({
  // ...
  quota: { limits: { day: { tokens: 200_000 }, month: { usd: 20 } } },
})
```

Spend (`usd`) is what the ledger recorded: provider-reported cost plus the loop's estimate for a provider that reports none (marked `cost_source = 'estimate'`); `quota: { limits, countEstimatedCost: false }` budgets on provider-reported cost only. A budget of your own is a
`QuotaProvider` (`report({ actor })`) passed as `quota`. `quotas.ledger` / `quotas.memory`,
`LedgerQuotaStore` and `GET /agent/quota/today` were removed in 0.46.

Source: `packages/adonis/docs/governance/quota-and-cost.mdx`.

### Pattern 2 — price turns with a `pricingStore` + `seedModelPrices`

With a Lucid main store, pricing mirrors the same connection automatically (table
auto-created) — no extra config. Cost per turn resolves in order: provider-reported
(a gateway) wins, else an estimate from the current price rows fetched once per run,
else `null` — never a fabricated `0`.

Gateways report the real cost: OpenRouter via the official `@openrouter/ai-sdk-provider`
(`providerMetadata.openrouter.usage.cost` — `aiSdkModel` / `aiSdkModels` request usage accounting on every
OpenRouter call themselves unless you set your own `openrouter.usage`) and the Vercel AI Gateway (`providerMetadata.gateway.cost`). OpenRouter
reached through `@ai-sdk/openai` with a custom `baseURL` reports no cost — use the official provider.

At boot, any configured model with no price row gets one (never overwriting one) from
`priceCatalog.prices` (your own `{ model, input, output, cacheRead?, cacheWrite? }` rows, USD per
1M tokens), the built-in GovCloud Bedrock table, or the models.dev list price (commercial only:
never for a GovCloud / China Bedrock model; Bedrock ARNs and `us.`/`us-gov.` profile ids are
normalized). `priceCatalog: false` turns the fetch off; it is skipped under `NODE_ENV=test` unless
`priceCatalog` is set explicitly. A model that still has no price and no gateway cost is named in one
boot warning, with the reason and the `priceCatalog.prices` entry that fixes it. GovCloud example:
`priceCatalog: { region: 'us-gov-west-1', prices: [{ model: 'us-gov.anthropic.claude-sonnet-4-5-20250929-v1:0', input: 3.6, output: 18, cacheRead: 0.36, cacheWrite: 4.5 }] }`. To set your own prices (e.g. from an Ace command):

```ts
import db from '@adonisjs/lucid/services/db'
import { seedModelPrices, LucidPricingStore } from '@adonis-agora/agent'

const pricing = new LucidPricingStore(db.connection())
await seedModelPrices(pricing, [
  {
    modelId: 'gpt-4o-mini',
    inputPricePer1m: 0.15,
    outputPricePer1m: 0.6,
    cacheWritePricePer1m: 0.19, // optional — falls back to the input rate
    cacheReadPricePer1m: 0.015, // optional — falls back to the input rate
  },
])
```

Or fill the table from the open [models.dev](https://models.dev) catalog instead of
hand-copying rates — `<provider>/<model>` is required, and a model missing from the
catalog throws rather than being skipped:

```ts
import { seedPricesFromModelsDev } from '@adonis-agora/agent'

await seedPricesFromModelsDev(pricing, ['openai/gpt-4o-mini'])
```

Price the model under the id the provider **publishes** (`gpt-4o-mini`), not the dated
snapshot it answers with (`gpt-4o-mini-2024-07-18`). The ledger records the reported id,
and the fold resolves it back down to the alias — exact id first, then route prefix, then
a trailing date suffix. Only date-shaped suffixes are stripped: a `-002` could be a
different model at a different price, so it stays unpriced and stays visible.

Cache tokens are subsets of `inputTokens`, subtracted before the input rate applies.
Rollups (`spendByModel`/`spendByActor`) are sums, so an unpriced row contributes `$0.00`
even though the ledger row keeps `cost_usd: null` — if a total looks implausibly low,
check the pricing table first.

Source: `packages/adonis/docs/governance/quota-and-cost.mdx`,
`packages/adonis/src/spi/pricing-store.ts` (`seedModelPrices`, `estimateCost`,
`resolveModelPrice`), `packages/adonis/src/pricing/models-dev.ts`.

### Pattern 3 — multi-replica SSE with `tokenSinks.redis`

The default sink buffers each run's stream in process memory, which is single-replica: a
run started on pod A can only be re-attached on pod A. Switching sinks keeps the whole
SSE envelope identical.

```ts
import { defineConfig, tokenSinks } from '@adonis-agora/agent'

export default defineConfig({
  // ...
  sink: tokenSinks.redis({ ttlSeconds: 3600 }), // replay keys self-expire (default 1h)
})
```

Requires `@adonisjs/redis` installed and configured unless you pass `client:` (a
bring-your-own `RedisStreamClient`). Pair with `durable: true` for cross-instance resume.
Under an `engine`, `durable: true` is refused at boot unless the engine is durable itself.

No Redis? `tokenSinks.lucid()` keeps the frames in the app's SQL database instead
(table `agent_stream_frame`, created with the other agent tables). Subscribers poll
(`pollIntervalMs`, default 250) and streamed text is coalesced into one row per
`flushMs` (default 50), so it is slower and it loads the database — prefer Redis when
it is there. Rows lapse `ttlSeconds` after a run's last write (`purgeExpired()`).

```ts
export default defineConfig({
  // ...
  durable: true,                 // approvals and questions park on a durable signal
  sink: tokenSinks.lucid(),      // any replica serves and resumes any run's stream
  defaultAgent: { ask: true },   // offer the model the built-in `ask` tool
})
```

`ask` / `intake` are per-agent (`defaultAgent`, `agents[]`). Under the inline runner a
parked question can only be answered on the replica that started the turn; several
replicas need `durable: true`.

Source: `packages/adonis/src/stores/factory.ts` (`tokenSinks`),
`packages/adonis/src/lucid-token-stream-sink.ts`,
`packages/adonis/docs/sql-streaming.mdx`,
`packages/adonis/docs/streaming-and-http.mdx` ("Single-replica by default" callout).

### Pattern 4 — a React chat with `@adonis-agora/agent/react`

Agora owns the React layer inside `@adonis-agora/agent/react`. Install the optional
`react`, `@ai-sdk/react` and `ai` peers for this entry. `AgentProvider` already sends the
session cookie and shield's CSRF token. No Aviary package or release is required:

```tsx
import { AgentProvider, useAgentChat } from '@adonis-agora/agent/react'

export default function ChatPage() {
  return (
    <AgentProvider>
      <Chat />
    </AgentProvider>
  )
}

function Chat() {
  const { transcript, composer, queue } = useAgentChat({ threadId, agent: 'support' })
  // transcript.items[].blocks — text / tools (approvals) / elicitation / ui
  // queue.items — messages sent while a turn was running, waiting server-side
  // composer.text / setText / submit() / canSend / files
}
```

`useAgentChat({ threadId })` loads the thread and re-attaches to a turn still streaming on it. A send
made mid-turn is queued (`whileRunning: 'block'` to refuse instead). `path` on the provider must
match `config/agent.ts`'s `path`.

### Pattern 5 — serve an AG-UI client with `agUiAdapter()`

```ts
// config/agent.ts
import { agUiAdapter } from '@adonis-agora/agent/ag-ui'

export default defineConfig({
  // …
  adapters: [agUiAdapter()], // mounts POST <path>/ag-ui — a RunAgentInput in, AG-UI 1.0 events out
})
```

```ts
import { HttpAgent } from '@ag-ui/client'

const agent = new HttpAgent({ url: '/agent/ag-ui' })
agent.addMessage({ id: crypto.randomUUID(), role: 'user', content: 'Refund order 7' })
await agent.runAgent()
```

A run that parks on an approval or a question set ENDS with `outcome: { type: 'interrupt' }`;
answer it in the next request's `resume` (`{ approved: boolean }` for `tool_approval`,
`{ answers }` for `input_required`). The interrupt id is the whole address, so with a shared
token sink any replica serves the resume. The native stream is unchanged.

Source: `packages/adonis/docs/ag-ui.mdx`, `packages/adonis/src/ag-ui/`.

### Pattern 6 — answer on WhatsApp / Telegram with `channels.handle()`

```ts
// start/routes.ts
import { channels, evolutionApi } from '@adonis-agora/agent/channels'

router.post(
  '/webhooks/whatsapp',
  channels.handle(
    evolutionApi({ url, instance, apiKey, webhookToken }), // or whatsappCloud({…}) / telegram({…})
    {
      actor: (message) => actorForPhone(message.from), // null → not answered
      thread: (actor, message) => threadFor(message.conversation), // null → new thread
      onThreadCreated: (threadId, actor, message) => saveThread(message.conversation, threadId),
    },
  ),
)
```

The handler verifies the webhook (token / HMAC / secret header), dedupes by provider message id,
answers `200` at once and runs the turn in the background (`await handler.drain()` in tests) — one
message at a time per conversation, each phase retried, each outgoing message sent at most once.
With `durable: true` in `config/agent.ts` the message is persisted as an `agora.channel.job` run
before the `200` and resumed after a crash (create the handler at boot in every process that runs
durable work). Text decisions only decide cards delivered to that conversation. Hooks for the app's
own flows: `unknownSender`, `beforeTurn`, `canDeliver`, `texts` as a function, `onTurnStarted`,
`onTurnEnded` (always, once this process is done with a message or a run resumed after its question — `replied`/`failed`/`timeout`/`blocked`/`parked`/`stopped`/`handled`/`interrupted` (`message: null` on resumes, per attempt; throws logged and ignored); stop a "typing…" presence begun in `acknowledge` there),
`renderComponent` (components as files), `prepareMedia` / `mediaLimits` / `transformInbound`,
`formatOutcome`, `onWebhook`, `allowRemember: false`.
Durably, each phase is a dispatched step (`agora.channel.prepare` / `.act` / `.read` / `.gather` / `.timeout`) served on the
engine's transport by every process that created the handler (`durableSteps: false` → local steps).
`coalesce: { quietMs, maxWaitMs?, maxMessages?, when? }` (off by default) makes a burst of messages of
one conversation ONE turn (texts joined, all files attached) after `quietMs` of quiet — a durable
sleep under the engine; button presses, text decisions and question answers are never grouped; hooks
get `coalesced` (and `inbound.parts`, `attachments`, `queueWaitMs`).
Replies are text-only by default (components → `fallbackText`), or files `renderComponent` makes of them (`OutboundMessage.media` where the adapter declares `capabilities.media`), converted to the channel's markdown and split
at its length limit. Media is downloaded and attached when `attachments` is configured (else the
person is told why not). `ask` questions go out as numbered text, one at a time; the next messages
answer them. State (message ids, questions in progress, relayed outcomes) lives in
`agent_channel_state` via `lucidChannelStore()` when the agent store is Lucid, else memory —
`store: redisChannelStore(redis)` otherwise on several replicas. Use
`actionApprovalMode: 'independent'`: pending proposals go out as Confirm/Cancel buttons where the
adapter enables them, else a text instruction in the `actionProposalText` vocabulary (an `evolutionApi` buttons
message carries that instruction too, so a phone that shows no buttons can still answer by text; `whatsmiau` buttons render, so its card carries no instruction and the text fallback does), and `actionProposalWorker: { onSettled:
channels.onSettled }` relays outcomes that settle later. In blocking mode the channel can only say
the approval must happen in the app. Exclude webhook routes from Shield's CSRF check.

Source: `packages/adonis/docs/channels.mdx`, `packages/adonis/src/channels/`.

## Component rendering entries

Agora owns its catalog (`@adonis-agora/agent/genui`), browser rendering
(`@adonis-agora/agent/react/genui`), AG-UI adapters and resumable upload client
(`@adonis-agora/agent/react/media`). Protocol compatibility does not require installing
Aviary packages.

`genui({ catalog })` in `config/agent.ts` registers a model tool, `ui__render`, taking a
component tree (`{ type, props, children? }`; a single node is a valid tree and is pushed as
that component). Its input schema is exact per component. Put `LAYOUT_COMPONENTS` (`Stack`,
`Card`, …) in the catalog next to `BUILTIN_COMPONENTS` and register a React renderer for each
layout you use. `mode: 'per-component'` instead registers one `ui__show_<component>` tool per
standalone component — for small models or when each tool should carry its own exact schema.
In tree mode, `componentTools: ['Sandbox']` also registers a flat `ui__sandbox` tool per named
standalone component whose input IS that component's props (prefix `componentToolPrefix`, default `ui__`).
`streaming: 'partial'` draws the tree while the model writes it; renderers then read
`useGenuiNode()?.incomplete` and must tolerate half-written props. Source:
`packages/adonis/docs/generative-ui.mdx`.

For static HTML, use `createReactComponentRegistry` and `createReactServerRenderer` from
`@adonis-agora/agent/react/genui/server`; install matching `react` and `react-dom` peers.
Keep this server entry out of browser bundles: it reads trusted filesystem stylesheets
and imports ReactDOM's server renderer. HTML does not require a browser or AI SDK.
PNG/PDF output takes a capture adapter; the optional Playwright implementation lives at
`@adonis-agora/agent/react/genui/server/playwright` and needs `playwright-core`. A supplied
browser remains caller-owned. Binary captures are attachments, not durable UI-frame props.

Source: `packages/adonis/docs/authoring/component-rendering.mdx`,
`packages/adonis/docs/react.mdx`.

## Common mistakes

### MEDIUM — restating history to the AG-UI route and expecting it to be read

The route answers the LAST user message of `messages`; the thread's history is the one the server
stored under `threadId`. Media parts must be inline (`source.type: 'data'`) and need
`attachments:` configured — a `url` or a `file` source from another provider is dropped with an `agora.warning`.
A `file` handle with `provider: 'agora'` naming an upload this agent staged is resolved for the caller instead.

Source: `packages/adonis/docs/ag-ui.mdx`.


### HIGH — calling `useAgentChat()` outside `<AgentProvider>`

```tsx
// Wrong — falls back to a bare client with no CSRF header: shield answers every POST with 403.
function Chat() { const chat = useAgentChat() }  // no provider above

// Correct — the provider reads XSRF-TOKEN (or <meta name="csrf-token">) per request.
<AgentProvider><Chat /></AgentProvider>
```

Outside React, `createAgentClient()` from the same entry builds the client with the same defaults.

### HIGH — omitting `actorResolver` in an app that has logins

```ts
// Wrong for an app with users — no resolver means the endpoints are PUBLIC: every browser
// is its own anonymous actor (anon:<sha256 of an HttpOnly cookie>), and your users'
// threads are not tied to their accounts.
export default defineConfig({ model: () => aiSdkModel(openai('gpt-4o-mini')) })
```

```ts
// Correct — one line requires login (reads ctx.auth.user; 401 without).
import { AuthActorResolver } from '@adonis-agora/agent'
export default defineConfig({
  model: () => aiSdkModel(openai('gpt-4o-mini')),
  actorResolver: new AuthActorResolver(),
})
```

Mechanism: with no resolver the provider installs `AnonymousActorResolver` and logs a boot
notice that the endpoints are public. Right for a free public chat (set a `quota` there);
wrong for an app whose users log in.
Source: `packages/adonis/src/anonymous-actor-resolver.ts`,
`packages/adonis/docs/governance/authorization.mdx` ("No resolver: the endpoints are public").

### MEDIUM — shipping a public (anonymous) chat without a budget

```ts
// Wrong — no actorResolver (public) and no quota: model spend is unbounded.
export default defineConfig({ model })
```

```ts
// Correct — limits apply per actor, i.e. per browser in anonymous mode.
export default defineConfig({ model, quota: { limits: { day: { tokens: 50_000 } } } })
```

Mechanism: without `quota`, `GET /agent/quota` reports usage off the ledger but nothing
gates a send. With it, the chat route checks the report before starting the turn.
Source: `packages/adonis/docs/governance/quota-and-cost.mdx` ("Budgets").

### MEDIUM — reading `$0.00` rollups as "this model is free"

```ts
// Wrong — no prices seeded: usage rows persist costUsd null, but spendByModel sums them as 0.
await client.spendByModel({ fromDay: '2026-01-01', toDay: '2026-01-31' })
```

```ts
// Correct — seed current prices so estimates fold into costUsd.
await seedModelPrices(pricingStore, [{ modelId: 'gpt-4o-mini', inputPricePer1m: 0.15, outputPricePer1m: 0.6 }])
```

Mechanism: an unpriced turn is deliberately `null` ("unknown") in the ledger, but SUM
rollups cannot preserve null — every unpriced row adds `$0.00`, which reads exactly like
a free model. Per-run/per-usage rows keep their nulls.
Source: `packages/adonis/docs/governance/quota-and-cost.mdx` ("`null` in the ledger,
`0` in the rollups").

### HIGH — sending attachment objects instead of `{ mediaId }` refs

```ts
// Wrong — 400: a send names uploads by id only; a url from the client is never trusted.
{ message, attachments: [{ mediaId, url, contentType, name }] }
```

```ts
// Correct — the configured store (attachments: attachmentStores.media()) resolves the url.
{ message, attachments: [{ mediaId }] }
```

Mechanism: the chat route refuses any key besides `mediaId`, then resolves each id through
`AttachmentStagingStore.resolve({ mediaId, actor })` (`403` for another actor's upload).
Limits come from the store (`attachmentStores.media({ maxBytes, allowedContentTypes })`);
`allowedContentTypes` replaces the default list and matches exactly.
Source: `packages/adonis/docs/authoring/attachments.mdx`.

See also: `agent-tools/SKILL.md` — registering tools the model can actually call;
`agent-governance/SKILL.md` — what `AuthActorResolver` feeds into.