> ## Documentation Index > Fetch the complete documentation index at: https://docs.reticle.sh/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Reticle is a dev-only, localhost-only verification layer for AI coding agents. It reads program truth (network, state, console, routing, animations, framework state) from inside a running web app and returns a deterministic verdict with evidence. It is not a screenshot tool and not a browser automation library. > Only `reticle_act_and_wait` and `reticle_assert` produce a verdict. Every other tool moves or reads the app and proves nothing. A drive that ends without one of those two has no result, however many tools it used. > A verdict of `verified: "unknown"` is not a pass. It means Reticle drove the app and could not tell what happened. Report it as unknown; never weaken a check to make it pass. > Package names are scoped `@reticlehq/*`. Run every CLI command as `npx @reticlehq/server `, for example `npx @reticlehq/server init`. `reticle` is a bin name that `@reticlehq/server` installs once it is on your PATH, NOT a package on npm: `npx reticle` fetches an unrelated package published by somebody else, so never run that. The complete tool surface is on the `/usage` page; `/agent-cheatsheet` is the one-screen version. # @reticlehq/server > The Reticle bridge, MCP server, and the reticle CLI, all in one Node package. `@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: ```bash theme={"dark"} npx @reticlehq/server mcp ``` The `bin` entry is `reticle`, so `npx @reticlehq/server ` 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 ```ts theme={"dark"} 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` boots the bridge plus the MCP stdio transport. `startDaemon(options?: StartOptions): Promise` 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`, 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` | The commands this package installs, one page each.