proofread-mcp 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Data Alchemy Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,191 @@
+# proofread-mcp
+
+An MCP server for [proofread.law](https://proofread.law). It lets Claude Desktop, Claude Code, Cursor and the OpenAI Agents SDK check US case citations before a draft is filed.
+
+proofread.law checks each citation against an open register of about 10 million court opinions (CourtListener bulk data). Every result says what was checked, what was found, and what the register cannot see.
+
+## What it does
+
+Six tools:
+
+| Tool | Input | What comes back |
+|---|---|---|
+| `check_citations` | text, `deep` (optional) | The coverage statement, counts per tier, one line per row that needs a human, the number of citations found, a report id |
+| `check_document` | path to a `.pdf`, `.docx` or `.txt` (up to 10 MB), `deep` (optional) | The same, for a file on disk |
+| `resolve_citation` | one citation string | The register's answer for that citation: found (case, court, date, parallel citations, link), ambiguous (candidates), not in the register, cannot verify, known citation, or no citation recognised; the coverage of that volume; the coverage statement |
+| `resolve_citations` | a list of up to 500 citation strings | Counts by status, one line per citation in input order, the coverage statement |
+| `coverage` | nothing | The coverage statement and the storage notice |
+| `render_report` | a report id from a previous check, or the full report JSON | A markdown diligence report |
+
+`check_citations` and `check_document` read prose: they compare the case name and any quotation with the register. `resolve_citation` and `resolve_citations` look the citation string up in the register (the `/v1/resolve` API) and tell you which case sits there; they do not compare it with the name you have.
+
+Tiers, in the words the tools use:
+
+| Tier | Word | Meaning |
+|---|---|---|
+| red | check this | The register holds something concrete that disagrees: a different case at that citation, a volume or page that does not match, quoted words not in the opinion |
+| orange | cannot verify | Nothing to check against: a Westlaw or Lexis identifier, a volume newer than the register, a reporter the register holds only in part. Not evidence either way |
+| green | found | The citation resolves to a case whose caption matches |
+| white | deep check | With `deep: true` only: whether the opinion supports the sentence it is cited for. A review queue, not a verdict |
+
+What it cannot do: resolve Westlaw (WL) or Lexis identifiers, check statutes, regulations or secondary sources, or say whether a case is still good law. Those limits are stated in every tool description and in the coverage statement that comes with every result.
+
+## Install
+
+Needs Node 20 or newer. No install step is required; `npx` fetches it.
+
+Until the package is on npm, clone this repository, run `npm install && npm run build`, and use `node /absolute/path/to/proofread-mcp/dist/cli.js` wherever the snippets below say `npx -y proofread-mcp`.
+
+### Claude Desktop
+
+Edit `claude_desktop_config.json` (Settings, Developer, Edit Config):
+
+```json
+{
+  "mcpServers": {
+    "proofread": {
+      "command": "npx",
+      "args": ["-y", "proofread-mcp"],
+      "env": {
+        "PROOFREAD_API_KEY": "pl_..."
+      }
+    }
+  }
+}
+```
+
+Leave out `env` to use the free tier.
+
+### Claude Code
+
+```bash
+claude mcp add proofread -- npx -y proofread-mcp
+# with a Firm key:
+claude mcp add proofread -e PROOFREAD_API_KEY=pl_... -- npx -y proofread-mcp
+```
+
+### Cursor
+
+Settings, MCP, Add new global MCP server, or write `.cursor/mcp.json` in the project:
+
+```json
+{
+  "mcpServers": {
+    "proofread": {
+      "command": "npx",
+      "args": ["-y", "proofread-mcp"],
+      "env": { "PROOFREAD_API_KEY": "pl_..." }
+    }
+  }
+}
+```
+
+### OpenAI Agents SDK (over HTTP)
+
+Start the server with the HTTP transport:
+
+```bash
+PROOFREAD_API_KEY=pl_... npx proofread-mcp --http --port 3333
+# MCP endpoint: http://127.0.0.1:3333/mcp   health: http://127.0.0.1:3333/health
+```
+
+Then connect from the Agents SDK:
+
+```python
+from agents import Agent, Runner
+from agents.mcp import MCPServerStreamableHttp
+
+async with MCPServerStreamableHttp(params={"url": "http://127.0.0.1:3333/mcp"}) as proofread:
+    agent = Agent(name="Drafting assistant", instructions="Check every case citation before you rely on it.", mcp_servers=[proofread])
+    result = await Runner.run(agent, "Check the citations in this paragraph: ...")
+```
+
+```ts
+import { Agent, run, MCPServerStreamableHttp } from "@openai/agents";
+
+const proofread = new MCPServerStreamableHttp({ url: "http://127.0.0.1:3333/mcp", name: "proofread" });
+await proofread.connect();
+const agent = new Agent({ name: "Drafting assistant", mcpServers: [proofread] });
+const result = await run(agent, "Check the citations in this paragraph: ...");
+```
+
+The HTTP server binds to 127.0.0.1 by default. To expose it on a network use `--host 0.0.0.0` and put it behind something that adds authentication; the server has none of its own.
+
+### Any MCP client
+
+stdio: run `proofread-mcp`. Streamable HTTP: run `proofread-mcp --http --port 3333` and point the client at `/mcp`.
+
+## Environment variables
+
+| Variable | Default | Meaning |
+|---|---|---|
+| `PROOFREAD_API_KEY` | unset | A Firm plan API key (`pl_...`), sent as `Authorization: Bearer`. Without it the free tier applies |
+| `PROOFREAD_API` | `https://proofread.law` | Base URL, for a self-hosted or test instance |
+
+## Free tier
+
+Without a key, per IP address and per month:
+
+| Tools | Quota |
+|---|---|
+| `check_citations`, `check_document` | 20 checks, of which 3 may be deep checks |
+| `resolve_citation`, `resolve_citations` | 1,000 resolves (each citation in a list counts as one) |
+| `coverage`, `render_report` | free, not counted |
+
+There is also a limit of 20 requests an hour per IP. When a limit is reached the tool returns a plain message with the retry time or the upgrade link; nothing is thrown at the protocol level.
+
+`.docx` upload and unlimited checks need a paid plan. See [proofread.law/pricing](https://proofread.law/pricing).
+
+## Privacy
+
+- The text or file goes to proofread.law, which runs on its own machine, not a cloud provider's API. It is processed in memory and discarded when the report is returned. Only counts (citations, tiers, timing) are logged, never text.
+- A citation string the local register cannot resolve may be looked up in the CourtListener citation API. Only the citation string leaves, never a party name or prose.
+- Deep check (`deep: true`) is opt-in. In that mode the clause before each citation (up to 700 characters) is sent to a model judge, together with the cited opinion. That is the only mode in which any of the document's prose leaves proofread.law.
+- This server stores nothing on disk. It keeps the last 50 reports in memory so `render_report` can be called with a short id; they are gone when the process exits.
+
+## The coverage caveat
+
+Every result starts with the coverage statement, for example:
+
+> Checked against 10.1 M cases (CourtListener bulk data 2026-06-30, last refreshed 2026-09-19); federal appellate 2019 to 2023 is 10 to 15% incomplete; Westlaw/Lexis identifiers are not resolvable; statutes, regulations and secondary sources are not checked.
+
+Read it. A citation that is not in the register is a register fact with a coverage qualifier, not proof that the case does not exist. A red row says "check this"; the tools say what was checked and what was found, never that a case is invented.
+
+## Example
+
+Input:
+
+> Title VII forbids discrimination because of sexual orientation. Bostock v. Clayton County, 509 U.S. 644 (2020).
+
+`check_citations` returns (real output, review instance, 2026-09-20):
+
+```
+Coverage: Checked against 10.1 M cases (CourtListener bulk data 2026-06-30, last refreshed 2026-09-19); federal appellate 2019 to 2023 is 10 to 15% incomplete; Westlaw/Lexis identifiers are not resolvable; statutes, regulations and secondary sources are not checked.
+Summary: 1 citation, 1 row. Check this (red): 1. Cannot verify (orange): 0. Found (green): 0.
+Flagged rows:
+- CHECK THIS: 509 U.S. 644 (Bostock v. Clayton County). Register has Bostock v. Clayton County at 590 U.S. 644. Check the volume. In the register, 509 U.S. 644 is Shaw v. Reno. The case named in the document exists; this citation does not point to it. Register: https://www.courtlistener.com/opinion/4760997/bostock-v-clayton-county/
+Found: 0 rows resolved to a case in the register.
+Report id: r_1ff74051 (give it to render_report for a markdown report). Elapsed: 0.03 s.
+Storage: Nothing you submit is stored. The document is processed in memory and discarded when this report is returned; only counts (citations, tiers, timing) are logged, never text.
+```
+
+## Development
+
+```bash
+npm install
+npm run build          # tsc -> dist/
+npm test               # vitest, mocked fetch, no network
+LIVE=1 npm test -- test/live.test.ts   # three live calls against proofread.law (counts against the free tier)
+node scripts/smoke-stdio.mjs           # spawn the stdio server, initialize, tools/list, four live tool calls
+node scripts/smoke-stdio.mjs --offline # the same without network
+```
+
+Layout: `src/client.ts` is the typed HTTP client (`/verify`, `/render`, `/api/coverage`, `/v1/resolve` single and batch), `src/format.ts` the compact formatter for checks, `src/resolve_format.ts` the one for register answers, `src/tools/<name>.ts` one file per tool, `src/server.ts` registers them, `src/cli.ts` picks the transport. The remaining register routes (`/v1/extract`, `/v1/case/{id}`, `/v1/coverage` per reporter) slot in the same way: one method on the client, one file under `src/tools/`.
+
+## Publishing
+
+See [RELEASE.md](RELEASE.md). The package is not on npm yet and the repository is private until the owner makes it public.
+
+## License
+
+MIT, Data Alchemy Labs.

package/dist/cli.d.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+interface Args {
+    http: boolean;
+    port: number;
+    host: string;
+    help: boolean;
+}
+export declare function parseArgs(argv: string[]): Args;
+export {};

package/dist/cli.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { startHttp } from "./http.js";
+import { createServer, SERVER_VERSION } from "./server.js";
+const HELP = `proofread-mcp ${SERVER_VERSION}: MCP server for proofread.law
+
+Usage:
+  proofread-mcp                 stdio transport (for Claude Desktop, Claude Code, Cursor)
+  proofread-mcp --http          Streamable HTTP at http://127.0.0.1:3333/mcp
+  proofread-mcp --http --port N --host H
+
+Environment:
+  PROOFREAD_API_KEY   Firm plan API key (pl_...). Without it the free tier applies.
+  PROOFREAD_API       Base URL (default https://proofread.law).
+`;
+export function parseArgs(argv) {
+    const args = { http: false, port: 3333, host: "127.0.0.1", help: false };
+    for (let i = 0; i < argv.length; i++) {
+        const a = argv[i];
+        if (a === "--http")
+            args.http = true;
+        else if (a === "--port")
+            args.port = Number(argv[++i]);
+        else if (a?.startsWith("--port="))
+            args.port = Number(a.slice(7));
+        else if (a === "--host")
+            args.host = String(argv[++i]);
+        else if (a?.startsWith("--host="))
+            args.host = a.slice(7);
+        else if (a === "--help" || a === "-h")
+            args.help = true;
+        else
+            throw new Error(`unknown argument ${a}`);
+    }
+    if (!Number.isInteger(args.port) || args.port < 0 || args.port > 65535)
+        throw new Error("--port must be 0..65535");
+    return args;
+}
+async function main() {
+    let args;
+    try {
+        args = parseArgs(process.argv.slice(2));
+    }
+    catch (err) {
+        console.error(String(err instanceof Error ? err.message : err));
+        console.error(HELP);
+        process.exit(2);
+    }
+    if (args.help) {
+        console.log(HELP);
+        return;
+    }
+    if (args.http) {
+        const { url } = await startHttp({ port: args.port, host: args.host });
+        console.error(`proofread-mcp listening on ${url}`); // stderr: stdout stays clean in both modes
+        return;
+    }
+    const server = createServer();
+    await server.connect(new StdioServerTransport());
+}
+main().catch((err) => {
+    console.error("proofread-mcp:", err instanceof Error ? err.message : err);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG,iBAAiB,cAAc;;;;;;;;;;CAU3C,CAAC;AASF,MAAM,UAAU,SAAS,CAAC,IAAc;IACtC,MAAM,IAAI,GAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC/E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,IAAI,CAAC,KAAK,QAAQ;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;aAChC,IAAI,CAAC,KAAK,QAAQ;YAAE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aAClD,IAAI,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC;YAAE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;aAC7D,IAAI,CAAC,KAAK,QAAQ;YAAE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aAClD,IAAI,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC;YAAE,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACrD,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;;YACnD,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,IAAI,IAAU,CAAC;IACf,IAAI,CAAC;QACH,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACtE,OAAO,CAAC,KAAK,CAAC,8BAA8B,GAAG,EAAE,CAAC,CAAC,CAAC,2CAA2C;QAC/F,OAAO;IACT,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAC9B,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC1E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,28 @@
+import type { Config } from "./config.js";
+import type { Coverage, Report, ResolveBatch, ResolveResult, Row } from "./types.js";
+export declare const USER_AGENT = "proofread-mcp/0.1.0 (+https://github.com/Data-Alchemy-Labs/proofread-mcp)";
+export declare const MAX_UPLOAD_BYTES: number;
+export type FetchLike = (input: string | URL, init?: RequestInit) => Promise<Response>;
+export interface VerifyOptions {
+    /** Run the support check (opt-in; the clause before each citation is sent to the model judge). */
+    deep?: boolean;
+    /** Deep mode only: when given, the client reads the SSE stream and reports each finished row. Without it, one JSON is requested. */
+    onRow?: (row: Row, report: Report) => void;
+    signal?: AbortSignal;
+}
+export declare const MAX_BATCH_CITES = 500;
+export interface Client {
+    verifyText(text: string, options?: VerifyOptions): Promise<Report>;
+    verifyFile(bytes: Uint8Array, filename: string, options?: VerifyOptions): Promise<Report>;
+    /** One citation string against the register (GET /v1/resolve). Counts against the resolve quota, not the check quota. */
+    resolveV1(cite: string, signal?: AbortSignal): Promise<ResolveResult>;
+    /** Up to 500 citation strings in one call (POST /v1/resolve); results come back in input order. */
+    resolveBatch(cites: string[], signal?: AbortSignal): Promise<ResolveBatch>;
+    renderMarkdown(report: Report, signal?: AbortSignal): Promise<string>;
+    coverage(signal?: AbortSignal): Promise<Coverage>;
+}
+export declare function createClient(config: Config, fetchImpl?: FetchLike): Client;
+/** `?deep=1` streams SSE by default; `&stream=0` asks for one JSON after all checks. A default check has no query. */
+export declare function verifyPath(deep: boolean, stream: boolean): string;
+/** AbortSignal.any arrived in Node 20.3; older 20.x gets the same behaviour by hand. */
+export declare function anySignal(signals: AbortSignal[]): AbortSignal;

package/dist/client.js

@@ -0,0 +1,107 @@
+import { ProofreadError } from "./errors.js";
+import { readSseReport } from "./sse.js";
+export const USER_AGENT = "proofread-mcp/0.1.0 (+https://github.com/Data-Alchemy-Labs/proofread-mcp)";
+export const MAX_UPLOAD_BYTES = 10 * 1024 * 1024;
+/** A default check answers in seconds; a deep check runs 1 to 2 s per citation, four in parallel, up to 15 minutes server-side. */
+const DEFAULT_TIMEOUT_MS = 120_000;
+const DEEP_TIMEOUT_MS = 16 * 60_000;
+export const MAX_BATCH_CITES = 500;
+export function createClient(config, fetchImpl = globalThis.fetch) {
+    const headers = (extra = {}) => ({
+        "User-Agent": USER_AGENT,
+        Accept: "application/json, text/event-stream",
+        ...(config.apiKey ? { Authorization: `Bearer ${config.apiKey}` } : {}),
+        ...extra,
+    });
+    async function call(path, init, timeoutMs, signal) {
+        const url = config.baseUrl + path;
+        let res;
+        try {
+            res = await fetchImpl(url, { ...init, signal: withTimeout(timeoutMs, signal) });
+        }
+        catch (cause) {
+            throw ProofreadError.fromFetchFailure(config.baseUrl, cause);
+        }
+        if (!res.ok)
+            throw ProofreadError.fromBody(res.status, await bodyAsJson(res));
+        return res;
+    }
+    async function verify(body, contentType, options) {
+        const deep = options.deep === true;
+        const path = verifyPath(deep, deep && options.onRow !== undefined);
+        const res = await call(path, { method: "POST", headers: headers(contentType ? { "Content-Type": contentType } : {}), body }, deep ? DEEP_TIMEOUT_MS : DEFAULT_TIMEOUT_MS, options.signal);
+        return readReport(res, options.onRow);
+    }
+    return {
+        verifyText: (text, options = {}) => verify(JSON.stringify({ text }), "application/json", options),
+        verifyFile(bytes, filename, options = {}) {
+            if (bytes.byteLength > MAX_UPLOAD_BYTES) {
+                throw new ProofreadError(413, "too_large", `${bytes.byteLength} bytes`);
+            }
+            const form = new FormData();
+            form.append("file", new Blob([new Uint8Array(bytes)]), filename);
+            return verify(form, undefined, options); // fetch sets the multipart boundary
+        },
+        async resolveV1(cite, signal) {
+            const res = await call(`/v1/resolve?cite=${encodeURIComponent(cite)}`, { method: "GET", headers: headers() }, DEFAULT_TIMEOUT_MS, signal);
+            return (await res.json());
+        },
+        async resolveBatch(cites, signal) {
+            if (cites.length > MAX_BATCH_CITES)
+                throw new ProofreadError(400, "too_many", `${cites.length} citations; the cap is ${MAX_BATCH_CITES} per call`);
+            const res = await call("/v1/resolve", { method: "POST", headers: headers({ "Content-Type": "application/json" }), body: JSON.stringify({ cites }) }, DEFAULT_TIMEOUT_MS, signal);
+            return (await res.json());
+        },
+        async renderMarkdown(report, signal) {
+            const res = await call("/render?format=md", { method: "POST", headers: headers({ "Content-Type": "application/json", Accept: "text/markdown" }),
+                body: JSON.stringify(report) }, DEFAULT_TIMEOUT_MS, signal);
+            return res.text();
+        },
+        async coverage(signal) {
+            const res = await call("/api/coverage", { method: "GET", headers: headers() }, DEFAULT_TIMEOUT_MS, signal);
+            return (await res.json());
+        },
+    };
+}
+/** `?deep=1` streams SSE by default; `&stream=0` asks for one JSON after all checks. A default check has no query. */
+export function verifyPath(deep, stream) {
+    if (!deep)
+        return "/verify";
+    return stream ? "/verify?deep=1" : "/verify?deep=1&stream=0";
+}
+async function readReport(res, onRow) {
+    const type = res.headers.get("content-type") ?? "";
+    if (type.startsWith("text/event-stream")) {
+        if (!res.body)
+            throw new ProofreadError(0, "empty_stream", "the event stream had no body");
+        return readSseReport(res.body, onRow);
+    }
+    return (await res.json());
+}
+async function bodyAsJson(res) {
+    try {
+        return await res.json();
+    }
+    catch {
+        return undefined;
+    }
+}
+function withTimeout(ms, signal) {
+    const timeout = AbortSignal.timeout(ms);
+    return signal ? anySignal([signal, timeout]) : timeout;
+}
+/** AbortSignal.any arrived in Node 20.3; older 20.x gets the same behaviour by hand. */
+export function anySignal(signals) {
+    if (typeof AbortSignal.any === "function")
+        return AbortSignal.any(signals);
+    const controller = new AbortController();
+    for (const s of signals) {
+        if (s.aborted) {
+            controller.abort(s.reason);
+            break;
+        }
+        s.addEventListener("abort", () => controller.abort(s.reason), { once: true });
+    }
+    return controller.signal;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,MAAM,CAAC,MAAM,UAAU,GAAG,2EAA2E,CAAC;AACtG,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjD,mIAAmI;AACnI,MAAM,kBAAkB,GAAG,OAAO,CAAC;AACnC,MAAM,eAAe,GAAG,EAAE,GAAG,MAAM,CAAC;AAYpC,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAC;AAanC,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,SAAS,GAAc,UAAU,CAAC,KAAK;IAClF,MAAM,OAAO,GAAG,CAAC,KAAK,GAA2B,EAAE,EAA0B,EAAE,CAAC,CAAC;QAC/E,YAAY,EAAE,UAAU;QACxB,MAAM,EAAE,qCAAqC;QAC7C,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,GAAG,KAAK;KACT,CAAC,CAAC;IAEH,KAAK,UAAU,IAAI,CAAC,IAAY,EAAE,IAAiB,EAAE,SAAiB,EAAE,MAAoB;QAC1F,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;QAClC,IAAI,GAAa,CAAC;QAClB,IAAI,CAAC;YACH,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAClF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9E,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,UAAU,MAAM,CAAC,IAAuB,EAAE,WAA+B,EAAE,OAAsB;QACpG,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC;QACnC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QACnE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,EACzH,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/D,OAAO,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,OAAO;QACL,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC;QAEjG,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,GAAG,EAAE;YACtC,IAAI,KAAK,CAAC,UAAU,GAAG,gBAAgB,EAAE,CAAC;gBACxC,MAAM,IAAI,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,UAAU,QAAQ,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YACjE,OAAO,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,oCAAoC;QAC/E,CAAC;QAED,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM;YAC1B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,oBAAoB,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC;YAC1I,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAkB,CAAC;QAC7C,CAAC;QAED,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM;YAC9B,IAAI,KAAK,CAAC,MAAM,GAAG,eAAe;gBAAE,MAAM,IAAI,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC,MAAM,0BAA0B,eAAe,WAAW,CAAC,CAAC;YACnJ,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EACjJ,kBAAkB,EAAE,MAAM,CAAC,CAAC;YAC9B,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAiB,CAAC;QAC5C,CAAC;QAED,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM;YACjC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;gBAC7I,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC;YAC9D,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;QACpB,CAAC;QAED,KAAK,CAAC,QAAQ,CAAC,MAAM;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC;YAC3G,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAa,CAAC;QACxC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,sHAAsH;AACtH,MAAM,UAAU,UAAU,CAAC,IAAa,EAAE,MAAe;IACvD,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,OAAO,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,yBAAyB,CAAC;AAC/D,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,GAAa,EAAE,KAA8B;IACrE,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IACnD,IAAI,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,IAAI;YAAE,MAAM,IAAI,cAAc,CAAC,CAAC,EAAE,cAAc,EAAE,8BAA8B,CAAC,CAAC;QAC3F,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAW,CAAC;AACtC,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,GAAa;IACrC,IAAI,CAAC;QACH,OAAO,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,EAAU,EAAE,MAAoB;IACnD,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AACzD,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,SAAS,CAAC,OAAsB;IAC9C,IAAI,OAAO,WAAW,CAAC,GAAG,KAAK,UAAU;QAAE,OAAO,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YACd,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YAC3B,MAAM;QACR,CAAC;QACD,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,UAAU,CAAC,MAAM,CAAC;AAC3B,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,7 @@
+export interface Config {
+    baseUrl: string;
+    apiKey?: string;
+}
+export declare const DEFAULT_BASE_URL = "https://proofread.law";
+/** Reads PROOFREAD_API (base URL) and PROOFREAD_API_KEY (Firm plan key) from the environment. */
+export declare function configFromEnv(env?: NodeJS.ProcessEnv): Config;

package/dist/config.js

@@ -0,0 +1,8 @@
+export const DEFAULT_BASE_URL = "https://proofread.law";
+/** Reads PROOFREAD_API (base URL) and PROOFREAD_API_KEY (Firm plan key) from the environment. */
+export function configFromEnv(env = process.env) {
+    const baseUrl = (env.PROOFREAD_API ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    const apiKey = env.PROOFREAD_API_KEY?.trim();
+    return apiKey ? { baseUrl, apiKey } : { baseUrl };
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,gBAAgB,GAAG,uBAAuB,CAAC;AAExD,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAAC,GAAG,GAAsB,OAAO,CAAC,GAAG;IAChE,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,aAAa,IAAI,gBAAgB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC5E,MAAM,MAAM,GAAG,GAAG,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC;IAC7C,OAAO,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;AACpD,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,13 @@
+/** An error answered by proofread.law, or a failure to reach it. `status` is 0 when no HTTP answer arrived. */
+export declare class ProofreadError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly info: Record<string, unknown>;
+    constructor(status: number, code: string, message: string, info?: Record<string, unknown>);
+    static fromBody(status: number, body: unknown): ProofreadError;
+    static network(baseUrl: string, cause: unknown): ProofreadError;
+    /** fetch rejected: our timeout fired, the MCP client cancelled, or the host was not reachable. */
+    static fromFetchFailure(baseUrl: string, cause: unknown): ProofreadError;
+}
+/** One plain sentence a model can act on. Wording follows PRODUCT.md: what was checked, what was found, what to do next. */
+export declare function explain(err: unknown): string;

package/dist/errors.js

@@ -0,0 +1,76 @@
+/** An error answered by proofread.law, or a failure to reach it. `status` is 0 when no HTTP answer arrived. */
+export class ProofreadError extends Error {
+    status;
+    code;
+    info;
+    constructor(status, code, message, info = {}) {
+        super(message);
+        this.name = "ProofreadError";
+        this.status = status;
+        this.code = code;
+        this.info = info;
+    }
+    static fromBody(status, body) {
+        const err = body?.error;
+        if (err && typeof err.code === "string") {
+            const { code, message, ...info } = err;
+            return new ProofreadError(status, code, message ?? code, info);
+        }
+        return new ProofreadError(status, `http_${status}`, `proofread.law answered HTTP ${status}`);
+    }
+    static network(baseUrl, cause) {
+        const detail = cause instanceof Error ? cause.message : String(cause);
+        return new ProofreadError(0, "network", `Could not reach ${baseUrl}: ${detail}`);
+    }
+    /** fetch rejected: our timeout fired, the MCP client cancelled, or the host was not reachable. */
+    static fromFetchFailure(baseUrl, cause) {
+        const name = cause instanceof Error ? cause.name : "";
+        if (name === "TimeoutError")
+            return new ProofreadError(0, "timeout", `no answer from ${baseUrl} in time`);
+        if (name === "AbortError")
+            return new ProofreadError(0, "cancelled", "the request was cancelled by the client");
+        return ProofreadError.network(baseUrl, cause);
+    }
+}
+/** One plain sentence a model can act on. Wording follows PRODUCT.md: what was checked, what was found, what to do next. */
+export function explain(err) {
+    if (!(err instanceof ProofreadError)) {
+        return `Unexpected error: ${err instanceof Error ? err.message : String(err)}`;
+    }
+    const i = err.info;
+    switch (err.code) {
+        case "network":
+        case "cancelled":
+            return err.message;
+        case "plan_required":
+            return `proofread.law: this needs the ${String(i.plan ?? "paid")} plan` +
+                (i.feature ? ` (${String(i.feature)})` : "") + ". " +
+                (i.upgrade ? `Upgrade at ${String(i.upgrade)}. ` : "") +
+                "A Firm API key goes in PROOFREAD_API_KEY.";
+        case "rate_limited":
+            return `proofread.law rate limit: ${err.message}.` +
+                (i.retry_after ? ` Retry after ${String(i.retry_after)} s.` : "");
+        case "quota_exceeded":
+            return `proofread.law monthly allowance used` +
+                (i.used !== undefined && i.limit !== undefined ? ` (${String(i.used)} of ${String(i.limit)})` : "") +
+                "." + (i.upgrade ? ` Upgrade at ${String(i.upgrade)}.` : "") +
+                " A Firm API key in PROOFREAD_API_KEY lifts the free-tier limits.";
+        case "bad_key":
+            return "proofread.law rejected the API key in PROOFREAD_API_KEY (unknown or revoked).";
+        case "missing_cite":
+        case "too_many":
+            return `proofread.law: ${err.message}.`;
+        case "too_large":
+            return `proofread.law: the input is too large (${err.message}); the cap is 10 MB.`;
+        case "unreadable":
+        case "unparseable":
+            return `proofread.law could not read the file: ${err.message}. Scanned PDFs without a text layer, encrypted PDFs and legacy .doc are not supported.`;
+        case "deep_budget_exhausted":
+            return "proofread.law: the deep-check budget for today is spent. Run the check without deep=true; the default check still works.";
+        case "timeout":
+            return `proofread.law timed out: ${err.message}. Try a shorter text or split the document.`;
+        default:
+            return `proofread.law error ${err.code} (HTTP ${err.status}): ${err.message}`;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA,+GAA+G;AAC/G,MAAM,OAAO,cAAe,SAAQ,KAAK;IAC9B,MAAM,CAAS;IACf,IAAI,CAAS;IACb,IAAI,CAA0B;IAEvC,YAAY,MAAc,EAAE,IAAY,EAAE,OAAe,EAAE,IAAI,GAA4B,EAAE;QAC3F,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,MAAc,EAAE,IAAa;QAC3C,MAAM,GAAG,GAAI,IAA8B,EAAE,KAAK,CAAC;QACnD,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACxC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,CAAC;YACvC,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,IAAI,IAAI,EAAE,IAAI,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,QAAQ,MAAM,EAAE,EAAE,+BAA+B,MAAM,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAAe,EAAE,KAAc;QAC5C,MAAM,MAAM,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtE,OAAO,IAAI,cAAc,CAAC,CAAC,EAAE,SAAS,EAAE,mBAAmB,OAAO,KAAK,MAAM,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,kGAAkG;IAClG,MAAM,CAAC,gBAAgB,CAAC,OAAe,EAAE,KAAc;QACrD,MAAM,IAAI,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,IAAI,IAAI,KAAK,cAAc;YAAE,OAAO,IAAI,cAAc,CAAC,CAAC,EAAE,SAAS,EAAE,kBAAkB,OAAO,UAAU,CAAC,CAAC;QAC1G,IAAI,IAAI,KAAK,YAAY;YAAE,OAAO,IAAI,cAAc,CAAC,CAAC,EAAE,WAAW,EAAE,yCAAyC,CAAC,CAAC;QAChH,OAAO,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;CACF;AAED,4HAA4H;AAC5H,MAAM,UAAU,OAAO,CAAC,GAAY;IAClC,IAAI,CAAC,CAAC,GAAG,YAAY,cAAc,CAAC,EAAE,CAAC;QACrC,OAAO,qBAAqB,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;IACjF,CAAC;IACD,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;IACnB,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,SAAS,CAAC;QACf,KAAK,WAAW;YACd,OAAO,GAAG,CAAC,OAAO,CAAC;QACrB,KAAK,eAAe;YAClB,OAAO,iCAAiC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO;gBACrE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI;gBACnD,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtD,2CAA2C,CAAC;QAChD,KAAK,cAAc;YACjB,OAAO,6BAA6B,GAAG,CAAC,OAAO,GAAG;gBAChD,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,KAAK,gBAAgB;YACnB,OAAO,sCAAsC;gBAC3C,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnG,GAAG,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5D,kEAAkE,CAAC;QACvE,KAAK,SAAS;YACZ,OAAO,+EAA+E,CAAC;QACzF,KAAK,cAAc,CAAC;QACpB,KAAK,UAAU;YACb,OAAO,kBAAkB,GAAG,CAAC,OAAO,GAAG,CAAC;QAC1C,KAAK,WAAW;YACd,OAAO,0CAA0C,GAAG,CAAC,OAAO,sBAAsB,CAAC;QACrF,KAAK,YAAY,CAAC;QAClB,KAAK,aAAa;YAChB,OAAO,0CAA0C,GAAG,CAAC,OAAO,wFAAwF,CAAC;QACvJ,KAAK,uBAAuB;YAC1B,OAAO,0HAA0H,CAAC;QACpI,KAAK,SAAS;YACZ,OAAO,4BAA4B,GAAG,CAAC,OAAO,6CAA6C,CAAC;QAC9F;YACE,OAAO,uBAAuB,GAAG,CAAC,IAAI,UAAU,GAAG,CAAC,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IAClF,CAAC;AACH,CAAC"}

package/dist/format.d.ts

@@ -0,0 +1,13 @@
+import type { Report, Row, Tier } from "./types.js";
+/** The words a user sees per tier (PRODUCT.md): say what was checked and what was found, never a verdict on the author. */
+export declare const TIER_WORD: Record<Tier, string>;
+/**
+ * A compact, model-friendly view of a report: the coverage statement first, then the counts,
+ * then one line per row that needs a human (red, orange and, in deep mode, white), then the count of found rows.
+ * Westlaw/Lexis identifiers are collapsed into one line, as on the site.
+ */
+export declare function formatReport(report: Report, reportId?: string): string;
+/** One line: tier word, citation (parties), headline, detail, register link. */
+export declare function formatRowLine(row: Row): string;
+/** A full view of one row, for resolve_citation. */
+export declare function formatRowDetail(row: Row): string;