Reticle Docs: verification for AI coding agents

@reticlehq/server hosts the WebSocket your app dials into, exposes the MCP tools your agent calls, and ships the reticle binary. Version 2.8.0. Licensed under SEE LICENSE IN LICENSE, not Apache 2.0 like the rest. This is the package the enterprise terms apply to.

Why it exists

Agents speak MCP. Browsers speak WebSocket. Somebody has to be fluent in both, and own the .reticle/ directory where flows, baselines, capsules and runs are stored. It never imports a DOM API.

Do you install it?

Not into your project. Your agent launches it:

npx @reticlehq/server mcp

The bin entry is reticle, so npx reticle <command> works once it is on disk.

Dependencies

Runtime: @modelcontextprotocol/sdk, @reticlehq/core, ws, zod. Optional: playwright, pixelmatch, pngjs. Optional on purpose: Reticle observes the browser you already have. You only need Playwright for the paths that launch or diff one, which is reticle drive, reticle verify, and visual baselines.

Exports map

Subpath	What it is
`.`	The programmatic API
`./cli`	The CLI entry, which also exports `parseCliArgs`, `CLI_USAGE` and the `CliResult` type

Starting a server in process

import { start, startDaemon, type StartOptions, type RunningServer } from '@reticlehq/server';

const server: RunningServer = await start({ port: 4400, headless: true });
await server.close();

start(options?: StartOptions): Promise<RunningServer> boots the bridge plus the MCP stdio transport. startDaemon(options?: StartOptions): Promise<RunningServer> is what the detached daemon runs.

`StartOptions`

Option	Type	Default
`port`	`number`	`RETICLE_PORT`, else `4400`
`host`	`string`	`RETICLE_HOST`, else loopback. A non-loopback host requires a token
`token`	`string`	`RETICLE_TOKEN`
`allowedOrigins`	`string[]`	`RETICLE_ALLOWED_ORIGINS`
`mcp`	`boolean`	`true`. `false` skips the stdio transport
`cdpUrl`	`string`	`RETICLE_CDP_URL`. Attach to a running browser instead of launching one
`driveUrl`	`string`	unset
`headless`	`boolean`	`true`
`realInputFactory`	`(opts) => OwnedRealInputProvider`	built in
`injectConnect`	`InjectConnectOptions`	unset
`storageState`	`string`	unset
`reticleRoot`	`string`	`cwd()/.reticle`
`pairingTokenDir`	`string`	`~/.reticle`
`now`	`() => number`	`Date.now`
`toolProfile`	`string`	`RETICLE_TOOL_PROFILE`, else `full`. `core` serves the lean surface
`httpVerify`	`boolean`	`false`
`httpVerifyPort`	`number`	`RETICLE_VERIFY_DEFAULT_PORT` (`7331`)
`httpVerifyToken`	`string`	`RETICLE_VERIFY_TOKEN`

`RunningServer`

bridge: Bridge, close(): Promise<void>, and the optional realInput, verifyPort, isIdle(), agentAttached(), token.

What else the barrel exports

A large surface, because the test runner and the CI paths are built on it. The families:

Family	Representative exports
Tools	`TOOLS`, `ReticleTool`, `runTool`, `createToolInvoker`, `filterTools`, `resolveToolSurface`, `CORE_TOOL_NAMES`, `SESSION_BOUND_TOOLS`, `SESSION_EXEMPT_TOOLS`
Bridge and sessions	`Bridge`, `Session`, `SessionManager`, `RingBuffer`, `resolveBridgeSecurity`, `buildSessionRecommendation`
Stores on disk	`FlowStore`, `BaselineStore`, `VisualStore`, `RecordingStore`, `RunStore`, `ProjectStore`, `AnnotationStore`, `createNodeFileSystem`, `reticleDirPaths`, `readContract`, `writeContract`
Flow replay	`replayFlow`, `assertSuccess`, `successToPredicate`, `classifyFlowAssertions`, `FlowAssertionGrade`, `nearestTestid`
Runs and CI	`ReticleRunner`, `buildVerificationRun`, `computeVerdict`, `renderRunReport`, `buildRepairPacket`, `classifyChangedFiles`, `buildRisks`, `redactForProfile`
HTTP verify	`handleVerifyRequest`, `createVerifyRequestListener`, `startVerifyServer`, `VERIFY_PATH`, `TOKEN_HEADER`, `tokenOk`
Predicates	`evaluatePredicate`, `waitForPredicate`, `PredicateSchema`, `buildReactionReport`
Browser pool	`BrowserPool`, `playwrightLauncher`, `resolveMaxContexts`, `DEFAULT_LEASE_TTL_MS`
Real input	`CdpRealInputProvider`, `LaunchedRealInputProvider`, `performGesture`, `boxCenter`, `isPointerAction`, `DriveError`
Daemon lifecycle	`writePid`, `readPid`, `removePid`, `isRunning`, `isAlive`, `logPath`, `classifyDaemonLife`, `DAEMON_HEARTBEAT_MS`
Crawl and scroll	`crawl`, `scrollToFind`
Visual	`diffPng`
Domain model	`buildDomainModel`

Every CLI command

The commands this package installs, one page each.

Tools

Beyond the loop

CLI commands

Packages

Grammar

Long form

@reticlehq/server

Why it exists

Do you install it?

Dependencies

Exports map

Starting a server in process

`StartOptions`

`RunningServer`

What else the barrel exports

Every CLI command

​Why it exists

​Do you install it?

​Dependencies

​Exports map

​Starting a server in process

​StartOptions

​RunningServer

​What else the barrel exports

Every CLI command

Why it exists

Do you install it?

Dependencies

Exports map

Starting a server in process

`StartOptions`

`RunningServer`

What else the barrel exports