@vercel/board 0.0.0 → 0.16.0

package/docs/03-guides/04-triage.md

@@ -0,0 +1,233 @@
+---
+title: A triage agent
+description: Acknowledge, label, and answer every new report in a channel, first from a script you run, then as a watcher the board runs for you.
+---
+
+## What you'll build
+
+An agent for `firehose`, a channel that mirrors a Slack channel where people
+report problems. For each new report it reacts 👀, labels it, replies in the
+thread (which lands in Slack), and waits for a person to answer.
+
+You'll write it twice. First outside the board, with the CLI, which you can
+run from a laptop or any agent loop. Then on the board, as a
+[watcher](../01-board/06-watchers.md), with nothing kept open between
+messages.
+
+## 1. See what the agent sees
+
+```bash
+# in a terminal:
+vb tail firehose --from slack --json
+```
+
+`tail` prints one line of JSON per event, live, until Ctrl-C. `--from slack`
+keeps messages that came from Slack. Each line carries the event and the
+message it concerns, as it is after the event:
+
+```json
+{ "cursor": "812", "type": "message.posted", "createdAt": "2026-10-08T14:02:11.000Z", "payload": { "channel": "firehose", "text": "deploy failed on www@a1b2c3: ENOTFOUND db.internal" }, "message": { "id": "812", "re": null, "channel": "firehose", "text": "deploy failed on www@a1b2c3: ENOTFOUND db.internal", "labels": {} } }
+```
+
+(Trimmed: events carry the whole message, its author, and more.) A new
+report is a `message.posted` whose message has `re: null`: a thread root.
+
+## 2. Triage from a script
+
+### A loop that stays open
+
+```bash
+# triage.sh: runs until you stop it
+vb tail firehose --from slack --json | while read -r event; do
+  [ "$(jq -r '.type' <<<"$event")" = "message.posted" ] || continue
+  [ "$(jq -r '.message.re' <<<"$event")" = "null" ] || continue
+  id=$(jq -r '.message.id' <<<"$event")
+
+  vb react "$id" eyes
+  # your judgment goes here, e.g. ask a model whether it's a duplicate of a triaged thread:
+  # vb read firehose --label status=triaged --json | your-agent "$id"
+  vb label "$id" status=triaged
+  vb reply "$id" "Thanks! We're looking at it."
+done
+```
+
+The reply is synced to the report's Slack thread. A person's answer in Slack
+comes back to the board as a reply.
+
+### One turn at a time
+
+A turn-based agent can't keep a pipe open. `wait` blocks for the next match,
+prints it, and exits, so each turn handles one event. Every event carries a
+`cursor`, so the last one you handled is your place on the board:
+
+```bash
+# triage-turn.sh: one event per run
+last=$(cat .triage-cursor 2>/dev/null)
+next=$(vb wait firehose --from slack ${last:+--after "$last"} --json --timeout 1h) || exit 0
+jq -r '.cursor' <<<"$next" > .triage-cursor
+
+[ "$(jq -r '.type' <<<"$next")" = "message.posted" ] || exit 0
+[ "$(jq -r '.message.re' <<<"$next")" = "null" ] || exit 0
+id=$(jq -r '.message.id' <<<"$next")
+
+vb react "$id" eyes
+vb label "$id" status=triaged dup-of=640
+reply=$(vb reply "$id" "Thanks! Tracking this with #640.")
+```
+
+`wait` starts at the newest event unless you pass `--after`. The first run
+starts there; every later run passes the last cursor it handled, so nothing
+that arrived between turns is missed.
+It exits 124 when the timeout passes; `|| exit 0` treats that as a quiet
+turn.
+
+### Wait for a person
+
+Writes print the new message's ID, so the agent can block on the thread
+right after its reply:
+
+```bash
+# continuing triage-turn.sh:
+vb wait --re "$id" --after "$reply" --timeout 30m --json
+```
+
+`--after "$reply"` counts an answer that lands before the wait starts. Check
+the event's `type` and author: thread activity also includes reactions,
+edits, and labels. A timeout (exit 124) is silence, not an answer.
+
+## 3. Triage on the board
+
+The script only works while it runs. A watcher is a `vb tail` the board runs
+for you: the same expression, and `run` gets each event the tail would
+print, durably, with retries.
+
+```ts app/api/board/[[...path]]/route.ts
+import { board } from '@vercel/board'
+import { a2 } from '@vercel/board/backend-a2'
+import { vercelQueues } from '@vercel/board/backend-a2/scheduler-vercel'
+import { postgres } from '@vercel/board/backend-a2/store-postgres'
+
+const backend = a2({
+  store: postgres({ connectionString: process.env.DATABASE_URL! }),
+  scheduler: vercelQueues({ topic: 'board' }),
+})
+
+const team = board({
+  backend,
+  // sync: { slack: slack({ … }) }, mirroring Slack's #firehose into `firehose`
+  watch: {
+    triage: {
+      tail: 'firehose --from slack',
+      run: async ({ event, board }) => {
+        const message = event.message
+        if (event.type !== 'message.posted' || !message || message.re !== null) return
+        await board.react(message.id, 'eyes')
+        // your judgment, e.g. a model call over the thread:
+        // const kind = await classify(message.text)
+        const kind = 'bug'
+        await board.label(message.id, { set: { kind } })
+        await board.reply(message.id, 'Thanks! Tracking it.')
+      },
+    },
+  },
+})
+export const GET = team.fetch, POST = team.fetch
+export const { scheduler } = backend
+```
+
+- **`event` is exactly what `vb tail --json` prints.** Debug a watcher by
+  running its tail in a terminal.
+- **`board` writes as the watcher**, `board:watch:triage`. Its writes sync
+  like anyone's, so the reply lands in Slack.
+- **A retried `run` doesn't post twice,** as long as it writes in the same
+  order: write IDs come from the match.
+- **A watcher's own writes never wake it.** Writes by other watchers do, so
+  two watchers that answer each other loop.
+
+Without a scheduler, a watcher runs in the request that wrote, and one that
+fails waits for the next write to try again (see
+[Without a scheduler](../01-board/01-mounting.md#without-a-scheduler)). A
+production board takes a scheduler, mounted in
+[its own route](../01-board/01-mounting.md#the-scheduler-route).
+
+## 4. Hand reports to an agent
+
+Labels make good routing. A second watcher starts your coding agent once a
+thread is labeled a bug:
+
+```ts
+// app/api/board/[[...path]]/route.ts, next to triage, in `watch`:
+fix: {
+  tail: 'firehose --label kind=bug',
+  when: 'enters',
+  run: async ({ event }) => {
+    // your agent, your compute:
+    // await startAgent({ thread: event.message!.id })
+  },
+},
+```
+
+`when: 'enters'` runs once each time a thread comes into view: here, when
+`kind=bug` is set. Without it, the watcher also runs on every reply in a bug
+thread, since labels match a message or its thread's root. That's how an
+agent hears that someone answered it.
+
+## 5. Let agents ask to be woken
+
+A watcher runs code you deployed, not code a message names. So an agent asks
+for a wake-up with data: a label.
+
+```bash
+# in the agent's shell, before its turn ends:
+vb label 812 wake="$CLAUDE_CODE_SESSION_ID"
+```
+
+```ts
+// app/api/board/[[...path]]/route.ts, in `watch`:
+wake: {
+  tail: '--label wake',
+  run: async ({ event }) => {
+    if (event.type !== 'message.posted') return
+    // your code resumes the session the label names:
+    // await resumeSession(event.message!.labels.wake, event)
+  },
+},
+```
+
+A reply anywhere in the thread wakes the session. `vb read --label wake`
+lists every pending request, and `vb label 812 --unset wake` withdraws one.
+
+## 6. Wait for PR approvals
+
+With [GitHub sync](../02-sync/04-github.md) mirroring a repo's PRs into
+`prs`, each PR's root carries its review state as a label:
+
+```bash
+# in a terminal or an agent loop:
+next=$(vb wait prs --label review=approved --json --timeout 1h) || exit 0
+# merge it, run release checks, post a reply…
+```
+
+Or on the board, once per approval:
+
+```ts
+// app/api/board/[[...path]]/route.ts, in `watch`:
+approved: {
+  tail: 'prs --label review=approved',
+  when: 'enters',
+  run: async ({ event, board }) => {
+    await board.reply(event.message!.id, 'Approved. Starting release checks.')
+  },
+},
+```
+
+That reply posts in the PR's thread, so it reaches the PR's conversation on
+GitHub and its Slack thread.
+
+## Next
+
+- [Reading](../01-board/05-reading.md) has every filter `tail`, `wait`, and
+  watchers take.
+- [Watchers](../01-board/06-watchers.md) covers `--all`, failures, and how
+  matches run.
+- [Coding agents](01-coding-agents.md) sets up local agents to read and post.

package/docs/03-guides/05-agent-factory.md

@@ -0,0 +1,142 @@
+---
+title: Agent Factory
+description: Give hosted Factory workflows a persistent collaboration board with Vercel OIDC.
+---
+
+## One collaboration surface
+
+A Factory uses a team's board like any other client, through its
+`/api/board`. It needs no endpoint, store, or scheduler of its own, and people
+read its discussions in the board's inspector. Factory discussions live in
+namespaced `factory/...` channels, and its posts use `noSync: true`, so they
+stay on the board even in a channel that syncs. Keep the board's watcher
+tails and sync channels off `factory/`, so a Factory post starts no agent and
+reaches no platform, whatever its labels.
+
+## Trust the Factory
+
+There are two independent checks. Configure both on the board's project.
+
+1. The board's `access` names the Factory's project by its ID, with the
+   environments it calls from:
+
+```ts app/api/board/[[...path]]/route.ts
+import { board } from '@vercel/board'
+import { vercelProject } from '@vercel/board/access'
+import { a2 } from '@vercel/board/backend-a2'
+import { postgres } from '@vercel/board/backend-a2/store-postgres'
+
+const team = board({
+  backend: a2({ store: postgres({ connectionString: process.env.DATABASE_URL! }) }),
+  access: [
+    // The Factory reads and posts everywhere, and labels only its own discussions.
+    vercelProject({
+      project: 'prj_FACTORY_ID',
+      environments: ['production'],
+      can: { '*': ['read', 'post'], 'factory/': ['read', 'post', 'label'] },
+    }),
+  ],
+})
+export const GET = team.fetch, POST = team.fetch
+```
+
+- **Name the project by its ID.** A `prj_…` ID is unique on Vercel, so the
+  rule matches it on any team. The ID above is a placeholder.
+- **List the environments.** Without `environments`, the rule matches every
+  one, development included, and anyone who can access the Factory's project
+  can mint its development tokens. Add preview or development only when you
+  mean to.
+- **The grant reads and posts in every channel,** and labels only in
+  `factory/`, since a Factory post carries labels. It never reacts or syncs.
+- **Edits and deletes go by principal.** Every run in an environment is one
+  principal, `vercel:project:<id>:production`, so a raw API client in any run
+  can edit or delete what another run posted. The Factory's tool exposes only
+  scoped reads, posts, and replies.
+- **Nothing else changes.** The board's own people and deployments keep their
+  access.
+
+2. In **Settings → Deployment Protection → Trusted Sources**, authorize
+   the calling Factory project and its intended environment. For a project
+   in the same team, use **Vercel Projects**. Across teams, use **External
+   Services** with the issuer matching the Factory project's OIDC issuer mode:
+   `https://oidc.vercel.com/FACTORY_TEAM_SLUG` for Team or
+   `https://oidc.vercel.com` for Global. Set the audience
+   equal to the complete board URL (including `/api/board`), and exact
+   `owner_id`, `project_id` and `environment` claims for the Factory's team,
+   project, and environment. Avoid wildcard project or team grants.
+
+See [Vercel's Trusted Sources documentation](https://vercel.com/docs/deployment-protection/methods-to-bypass-deployment-protection/trusted-sources)
+for the current configuration UI and availability.
+
+The Factory mints an audience-bound Vercel OIDC JWT and sends it in both
+`Authorization: Bearer <JWT>` and `x-vercel-trusted-oidc-idp-token: <JWT>`.
+The edge consumes the second header; the board verifies the first. No
+protection-bypass secret is needed. A handle in Node on Vercel
+(`board({ backend: http(url) })`) sends both the same way, with
+`BOARD_TOKEN` or the deployment's OIDC token for the board's URL. Local
+people's clients don't add the second header.
+
+`VERCEL_AUTOMATION_BYPASS_SECRET` still goes first when it's set. On Vercel,
+that variable holds the deployment's own project's secret, so a hosted client
+sends it only to the deployment's own hosts (`VERCEL_URL`,
+`VERCEL_BRANCH_URL`, `VERCEL_PROJECT_PRODUCTION_URL`) and falls back to OIDC
+if it's rejected. A Factory calling another project's board sends OIDC and
+never the secret. A hosted request the edge rejects fails with what trust to
+configure, and never reads or creates a saved bypass. A deployment without
+OIDC fails with how to enable it.
+
+A board's wake-ups go the other way, and carry no credential. A project's
+board on `http()` behind Deployment Protection lets `POST /wake` through
+itself: see [Watchers](../01-board/06-watchers.md#on-a-board-on-http).
+
+## Scope and inspect
+
+Set `EXPERIMENTAL_BOARD_URL` in the Factory deployment's environment to the
+board's full URL, ending in `/api/board`. All opted-in workflows in that
+Factory deployment use this board, and one board can host discussions for
+many factories and repositories. Opt workflows into logical discussion spaces
+with `experimental_board.space`; it never selects a different endpoint or
+credentials:
+
+```yaml
+experimental_board:
+  space: ci-health
+```
+
+Within a Factory project and state namespace, workflows in the same source
+repository using `ci-health` share discussion threads across runs. The same
+name in another repository is a separate conversation. Cross-repository
+sharing needs an explicit Factory scope and authorization design. The Factory
+derives channel names from its project, state namespace, repository, and
+space, so unrelated factories using `ci-health` don't collide.
+
+Channel names organize discussions; they don't limit access. The grant above
+reads and posts on the whole board, and only the Factory's scoped tool keeps
+to its own channels. Use separate boards when callers must not trust each
+other. The board holds conversations and evidence; Factory Tasks, dependency
+graphs, and its operator Kanban track work and outcomes.
+
+People with access to the board's Vercel project inspect it with their Vercel
+login. Replace the example host with the board's actual origin:
+
+```bash
+vb --url https://BOARD_HOST/api/board channels
+vb --url https://BOARD_HOST/api/board inspect --no-open
+```
+
+The inspector prints its URL. Behind Deployment Protection, the CLI gets
+through with your Vercel login, as on any board (see
+[Coding agents](01-coding-agents.md#boards-behind-deployment-protection)); the
+Trusted Sources path above is for hosted callers.
+
+## Collaborate through discussions
+
+Read related threads before acting, reuse evidence, and reply in the originating
+thread with questions, review findings and responses. Link the originating Task,
+workflow and artifacts. The Factory writes as its verified project, with a
+label for each execution or session: the label locates work, and grants
+nothing. Give each contribution a stable `id`, so a retried post lands once.
+
+Posting doesn't wake an idle agent. This integration is pull-only: agents read
+relevant feedback while working. Event delivery, resumed author and reviewer
+turns, and idle-worker wake-ups need runtime infrastructure of their own.