@echofiles/echo-pdf 0.4.3 → 0.6.0

package/README.md

@@ -1,86 +1,82 @@
 # echo-pdf
 
-`echo-pdf` 当前阶段定位为本地优先的 PDF context engine for AI agents。
+`echo-pdf` is a local-first, vision-language-first PDF context engine for AI agents.
 
-一句话定义：
+It turns a local PDF into reusable CLI outputs, Node/Bun library primitives, and inspectable workspace artifacts for page rendering, page understanding, semantic structure, and downstream local reuse.
 
-- 把本地 PDF 处理成可复用的 CLI outputs、library primitives 和 workspace artifacts，供本机 agent/app 继续消费。
+## What It Is
 
-当前主线产品形态：
+Primary product surfaces:
 
-- npm package：`@echofiles/echo-pdf`
-- CLI：`echo-pdf ...`
-- 本地 workspace artifacts：`.echo-pdf-workspace/...`
-- 文档站：仅用于说明安装、CLI、artifacts 和集成契约，不提供在线处理服务
+- npm package: `@echofiles/echo-pdf`
+- local CLI: `echo-pdf ...`
+- local workspace artifacts: `.echo-pdf-workspace/...`
+- docs site: [pdf.echofile.ai](https://pdf.echofile.ai/)
 
-目标用户与主要用法：
+Current focus:
 
-- 需要在本机或本地开发环境处理 PDF 的 agent / IDE / app 开发者
-- 需要稳定页级 primitives、document context 和可缓存 artifacts 的下游集成方
-- 需要 clean consumer import + CLI workflow 的本地组件使用方
+- local-first workflows
+- VL-first page understanding
+- stable page-level document primitives
+- reusable workspace artifacts
+- clean package entrypoints for downstream consumers
 
-当前阶段能力：
+Non-goals for this phase:
 
-- 页面提取：把 PDF 指定页渲染为图片
-- OCR：识别页面文本
-- 表格识别：提取表格并输出 LaTeX `tabular`
-- 页级文档索引：生成本地可复用的 document / page artifacts
-- 语义结构层：在 page index 之上产出可缓存的 heading / section 结构
-- 页面渲染与 OCR artifacts：把 page render/image 与 OCR 结果缓存到本地 workspace
+- hosted SaaS
+- treating MCP as the primary product entrypoint
+- turning the docs site into an online PDF processing service
+- domain-specific logic such as datasheet- or EDA-specific extraction behavior
 
-当前阶段优先：
+## Install
 
-- 本地 CLI
-- 本地 library/client API
-- 本地 workspace artifacts
-- clean-consumer npm package
+Requirements:
 
-当前阶段非重点：
+- Node.js `>=20`
+- ESM-capable runtime
 
-- MCP 扩展或把 MCP 作为主入口
-- Hosted SaaS / multi-tenant 平台能力
-- 把网站做成在线 PDF 服务
-- datasheet / EDA 等领域特化逻辑
+Install globally for CLI use:
 
-进一步的定位说明见：
+```bash
+npm i -g @echofiles/echo-pdf
+```
 
-- [`docs/PRODUCT.md`](./docs/PRODUCT.md)
-- [`docs/PACKAGING.md`](./docs/PACKAGING.md)
-- [`docs/WORKSPACE_CONTRACT.md`](./docs/WORKSPACE_CONTRACT.md)
-- [`docs/DEVELOPMENT.md`](./docs/DEVELOPMENT.md)
+Or install as a dependency:
 
-## Local-first workflow
+```bash
+npm i @echofiles/echo-pdf
+```
+
+## Quick Start
 
-最短路径：
+Index a local PDF and inspect its page-level context:
 
 ```bash
-npm i -g @echofiles/echo-pdf
 echo-pdf document ./sample.pdf
 echo-pdf structure ./sample.pdf
-echo-pdf semantic ./sample.pdf
 echo-pdf page ./sample.pdf --page 1
-echo-pdf render ./sample.pdf --page 1
-echo-pdf ocr ./sample.pdf --page 1 --model gpt-4.1-mini
+echo-pdf render ./sample.pdf --page 1 --scale 2
 ```
 
-源码 checkout 的本地开发路径：
+To run the VL-first semantic path locally, configure a provider key and model once, then run `semantic`:
 
 ```bash
-npm install
-npm run document:dev -- document ./fixtures/smoke.pdf
-npm run document:dev -- structure ./fixtures/smoke.pdf
-npm run document:dev -- semantic ./fixtures/smoke.pdf
-npm run document:dev -- page ./fixtures/smoke.pdf --page 1
+echo-pdf provider set --provider openai --api-key "$OPENAI_API_KEY"
+echo-pdf model set --provider openai --model gpt-4.1-mini
+echo-pdf semantic ./sample.pdf
 ```
 
-说明：
+`echo-pdf semantic` now uses the CLI profile's provider/model/api-key settings. If the selected provider or model is missing, it fails early with a clear setup error instead of quietly dropping back to a weaker path.
+
+What these commands map to:
 
-- 发布包 / 已构建 checkout：`echo-pdf document ...` 继续走 `dist/`
-- 源码 checkout 且还没 build：使用 `npm run document:dev -- ...`
-- `document:dev` 只用于本地开发；它会显式优先加载 `src/local/index.ts`，即使仓库里仍然存在旧 `dist/`
-- 发布包和正常 `echo-pdf document ...` 仍然只走 `dist/`
+- `document` -> `get_document`
+- `structure` -> `get_document_structure`
+- `semantic` -> `get_semantic_document_structure`
+- `page` -> `get_page_content`
+- `render` -> `get_page_render`
 
-默认会在当前目录写入可检查的 workspace：
+By default, `echo-pdf` writes reusable artifacts into a local workspace:
 
 ```text
 .echo-pdf-workspace/
@@ -95,26 +91,12 @@ npm run document:dev -- page ./fixtures/smoke.pdf --page 1
     renders/
       0001.scale-2.json
       0001.scale-2.png
-    ocr/
-      0001.scale-2.provider-openai.model-gpt-4o.prompt-<hash>.json
 ```
 
-这些 artifacts 会在 PDF 未变化时被复用，便于本地下游产品（例如 echo-datasheet）做增量读取。
-
-正式的 workspace layout、cache/invalidation、detector/strategy metadata、以及下游可依赖边界，见 [`docs/WORKSPACE_CONTRACT.md`](./docs/WORKSPACE_CONTRACT.md)。
-
-## Local library/client API
-
-当前阶段优先提供本地可组合 primitives，让下游产品直接围绕 PDF 建立 document metadata / page-level artifacts，而不是先依赖远端 MCP/SaaS。
+These artifacts are meant to be inspected, cached, and reused by downstream local tools.
+## Library Usage
 
-### Local-first entrypoints（semver 稳定）
-
-- `@echofiles/echo-pdf`：core API
-- `@echofiles/echo-pdf/core`：与根入口等价的 core API
-- `@echofiles/echo-pdf/local`：本地 document primitives
-- `@echofiles/echo-pdf/worker`：兼容保留的 Worker 路由入口，不是本阶段重点
-
-### Local document primitives
+Use the local document primitives directly from Node/Bun:
 
 ```ts
 import {
@@ -123,523 +105,64 @@ import {
   get_semantic_document_structure,
   get_page_content,
   get_page_render,
-  get_page_ocr,
 } from "@echofiles/echo-pdf/local"
 
-const doc = await get_document({ pdfPath: "./sample.pdf" })
-const pageIndex = await get_document_structure({ pdfPath: "./sample.pdf" })
+const document = await get_document({ pdfPath: "./sample.pdf" })
+const structure = await get_document_structure({ pdfPath: "./sample.pdf" })
 const semantic = await get_semantic_document_structure({ pdfPath: "./sample.pdf" })
 const page1 = await get_page_content({ pdfPath: "./sample.pdf", pageNumber: 1 })
-const render1 = await get_page_render({ pdfPath: "./sample.pdf", pageNumber: 1 })
-const ocr1 = await get_page_ocr({ pdfPath: "./sample.pdf", pageNumber: 1, model: "gpt-4.1-mini" })
-```
-
-这些调用会把 artifacts 写入本地 workspace，并在 PDF 未变化时尽量复用已有页面结果。
-`get_document_structure()` 继续返回最小 page index：`document -> pages[]`。
-`get_semantic_document_structure()` 单独返回 heading / section 语义层，并写入 `semantic-structure.json`。
-`get_page_render()` 会生成可复用的 PNG + metadata。
-`get_page_ocr()` 会把 OCR 结果写入独立 artifact；它需要本地 provider key / model，不依赖 MCP 或远端服务入口。
-
-### Page Index vs Semantic Structure
-
-- `get_document_structure()`
-  - 契约：稳定的 `document -> pages[]`
-  - artifact：`structure.json`
-  - 目的：给下游做页级遍历、page artifact 定位、增量读取
-- `get_semantic_document_structure()`
-  - 契约：显式的 heading / section 语义层，优先走本地 provider/model 的 agent 抽取；未配置或失败时退回保守 heuristic
-  - artifact：`semantic-structure.json`
-  - 目的：给下游做章节导航、语义分段；它不替代 page index，也不改变 `pages[]` 输出
-
-当前 semantic 结构会把 detector 明确写入 artifact：
-
-- `agent-structured-v1`：使用本地配置的 provider/model 对 page text 进行结构化抽取
-- `heading-heuristic-v1`：当本地未配置模型，或 agent 抽取失败时使用的保守回退
-
-两种模式都遵循同一输出契约；检测不到时会返回空结构，而不是伪造 section tree。
-
-## Tool library compatibility
-
-除了 local-first primitives 之外，`@echofiles/echo-pdf` 仍保留现有 `pdf_extract_pages / pdf_ocr_pages / pdf_tables_to_latex / file_ops` 工具实现的复用入口，用于兼容已有集成。
-
-### Public entrypoints（semver 稳定）
-
-- `@echofiles/echo-pdf`：core API
-- `@echofiles/echo-pdf/core`：与根入口等价的 core API
-- `@echofiles/echo-pdf/local`：本地 document primitives
-- `@echofiles/echo-pdf/worker`：Worker 路由入口（兼容保留）
-
-仅以上 `exports` 子路径视为公开 API。`src/*`、`dist/*` 等深路径导入不受兼容性承诺保护，可能在次版本中变动。
-
-完整的 package entrypoint、runtime、semver、以及 clean-consumer import 保证，见 [`docs/PACKAGING.md`](./docs/PACKAGING.md)。
-
-### Runtime expectations
-
-- Node.js: `>=20`（与 `package.json#engines` 一致）
-- 需要 ESM `import` 能力与标准 `fetch`（Node 20+ 原生支持）
-- `@echofiles/echo-pdf/local` 面向本地 Node/Bun CLI 或 app runtime
-- 建议使用支持 package `exports` 的现代 bundler/runtime（Vite、Webpack 5、Rspack、esbuild、Wrangler 等）
-- TypeScript 消费方建议：`module=NodeNext` + `moduleResolution=NodeNext`
-
-### Clean project import smoke
-
-下面这段命令与仓库中的集成测试保持一致，可在全新目录验证 npm 包“可直接 import”：
-
-```bash
-tmpdir="$(mktemp -d)"
-cd "$tmpdir"
-npm init -y
-npm i /path/to/echofiles-echo-pdf-<version>.tgz
-node --input-type=module -e "await import('@echofiles/echo-pdf'); await import('@echofiles/echo-pdf/core'); await import('@echofiles/echo-pdf/local'); await import('@echofiles/echo-pdf/worker'); console.log('ok')"
-```
-
-### Example
-
-```ts
-import { callTool, listToolSchemas } from "@echofiles/echo-pdf"
-import configJson from "./echo-pdf.config.json" with { type: "json" }
-
-const fileStore = {
-  async put(input) {
-    const id = crypto.randomUUID()
-    const record = { ...input, id, sizeBytes: input.bytes.byteLength, createdAt: new Date().toISOString() }
-    memory.set(id, record)
-    return record
-  },
-  async get(id) {
-    return memory.get(id) ?? null
-  },
-  async list() {
-    return [...memory.values()]
-  },
-  async delete(id) {
-    return memory.delete(id)
-  },
-}
-
-const memory = new Map()
-const env = {}
-
-console.log(listToolSchemas().map((tool) => tool.name))
-
-const result = await callTool(
-  "pdf_extract_pages",
-  { fileId: "<FILE_ID>", pages: [1], returnMode: "inline" },
-  { config: configJson, env, fileStore }
-)
-console.log(result)
-```
-
-版本策略：
-
-- `exports` 列出的入口及其导出符号按 semver 管理
-- 对公开 API 的破坏性变更只会在 major 版本发布
-- 新增导出、参数扩展（向后兼容）会在 minor/patch 发布
-
-## 1. Compatibility surfaces（deferred / not primary）
-
-以下内容是当前仓库中兼容保留的入口，不是本阶段主线产品形态。
-主线仍然是 npm package + CLI + local workspace artifacts；网站只是文档站，不是在线服务。
-
-请先确定你的线上地址（Worker 域名）。文档里用：
-
-- `https://echo-pdf.echofilesai.workers.dev`
-
-你自己的地址如果不同，把下面命令里的域名全部替换掉。
-
-主要端点：
-
-- Web UI: `https://echo-pdf.echofilesai.workers.dev/`
-- MCP: `https://echo-pdf.echofilesai.workers.dev/mcp`
-- HTTP API 根路径: `https://echo-pdf.echofilesai.workers.dev`
-
-## 1.1 API 兼容性说明
-
-- 从 `v0.3.0` 开始，`POST /tools/call` 返回结构改为：
-  - `{"ok": true, "data": ..., "artifacts": [...]}`
-- 老格式 `{"name":"...","output":...}` 已移除。
-- MCP `tools/call` 仍保留 `type:"text"`，并新增 `type:"resource_link"` 供下载二进制结果。
-
-## 2. 快速开始（CLI）
-
-安装：
-
-```bash
-npm i -g @echofiles/echo-pdf
+const render1 = await get_page_render({ pdfPath: "./sample.pdf", pageNumber: 1, scale: 2 })
 ```
 
-初始化服务地址：
+Notes:
 
-```bash
-echo-pdf init --service-url https://echo-pdf.echofilesai.workers.dev
-```
+- `get_document_structure()` returns the stable page index: `document -> pages[]`
+- `get_semantic_document_structure()` returns a separate semantic structure layer; it does not replace `pages[]`
+- `get_page_render()` materializes a reusable PNG plus render metadata and is the mainline visual input path
 
-本地一键启动服务（daemon）：
+Migration note:
 
-```bash
-echo-pdf dev --port 8788
-echo-pdf init --service-url http://127.0.0.1:8788
-```
+- older workspaces may still contain `ocr/*` artifacts from pre-VL-first builds, but they are no longer part of the supported first-class contract
 
-配置 API Key（仅保存在本机 CLI 配置，不会上报到服务端存储）：
+## Public Package Entrypoints
 
-```bash
-echo-pdf provider set --provider openai --api-key <OPENAI_API_KEY>
-echo-pdf provider set --provider openrouter --api-key <OPENROUTER_KEY>
-echo-pdf provider set --provider vercel-ai-gateway --api-key <VERCEL_AI_GATEWAY_API_KEY>
-```
+The semver-stable public entrypoints are:
 
-设置默认 provider + model（项目采用单一默认，不做多层 fallback）：
+- `@echofiles/echo-pdf`
+- `@echofiles/echo-pdf/local`
 
-```bash
-echo-pdf provider use --provider vercel_gateway
-echo-pdf model set --provider vercel_gateway --model google/gemini-3-flash
-echo-pdf model list
-```
+`@echofiles/echo-pdf` and `@echofiles/echo-pdf/local` expose the same supported local-first library surface.
 
-拉取 provider 模型列表（实时从 provider API 获取，无 hardcode）：
+Everything else, including deep imports such as `src/*` or `dist/*`, is private implementation detail.
 
-```bash
-echo-pdf models --provider vercel_gateway
-```
+## Docs
 
-修改运行时配置（写入 `.dev.vars` 的 `ECHO_PDF_CONFIG_JSON`）：
+Contract and product docs:
 
-```bash
-echo-pdf config set --key service.maxPdfBytes --value 10000000
-echo-pdf config set --key service.storage.maxFileBytes --value 10000000
-echo-pdf config set --key service.maxPagesPerRequest --value 20
-```
-
-## 2.1 六个核心 primitives
-
-本地 CLI 主命令面与 `@echofiles/echo-pdf/local` 的六个 primitives 一一对应：
-
-- `document <file.pdf>` -> `get_document`
-- `structure <file.pdf>` -> `get_document_structure`
-- `semantic <file.pdf>` -> `get_semantic_document_structure`
-- `page <file.pdf> --page <N>` -> `get_page_content`
-- `render <file.pdf> --page <N>` -> `get_page_render`
-- `ocr <file.pdf> --page <N>` -> `get_page_ocr`
+- [Product positioning](./docs/PRODUCT.md)
+- [Package entrypoints and integration guarantees](./docs/PACKAGING.md)
+- [Workspace artifact contract](./docs/WORKSPACE_CONTRACT.md)
+- [Development guide](./docs/DEVELOPMENT.md)
+- [Shared sample assets](./samples/README.md)
+- [Eval harness](./eval/README.md)
 
-兼容边界：
+Published docs site:
 
-- 旧的 `document get|index|structure|semantic|page|render|ocr ...` 仍作为兼容别名保留
-- README 和 `--help` 现在优先展示这六个主命令，而不是旧的子命令树
+- [pdf.echofile.ai](https://pdf.echofile.ai/)
 
-建立本地索引并输出 metadata：
-
-```bash
-echo-pdf document ./sample.pdf
-```
-
-读取结构树：
-
-```bash
-echo-pdf structure ./sample.pdf
-```
-
-读取语义结构层：
-
-```bash
-echo-pdf semantic ./sample.pdf
-```
-
-读取指定页面内容：
-
-```bash
-echo-pdf page ./sample.pdf --page 1
-```
-
-生成页面渲染 artifact：
-
-```bash
-echo-pdf render ./sample.pdf --page 1 --scale 2
-```
-
-生成 OCR artifact（需要本地 provider key / model）：
-
-```bash
-echo-pdf ocr ./sample.pdf --page 1 --model gpt-4.1-mini
-```
-
-自定义 artifact workspace：
-
-```bash
-echo-pdf document ./sample.pdf --workspace ./.cache/echo-pdf
-```
-
-## 3. MCP 使用（兼容保留，非本阶段重点）
-
-### 3.1 检查 MCP 服务可用
-
-```bash
-echo-pdf mcp initialize
-echo-pdf mcp tools
-echo-pdf mcp call --tool file_ops --args '{"op":"list"}'
-```
-
-### 3.1.1 纯 MCP 场景推荐流程（本地 PDF）
-
-远端 MCP server 无法直接读取你本机文件路径。推荐两步：
-
-1. 先通过 HTTP 上传本地 PDF，拿到 `fileId`
-2. 再用 MCP 工具传 `fileId` 调用
-
-示例：
-
-```bash
-curl -sS -X POST https://echo-pdf.echofilesai.workers.dev/api/files/upload \
-  -F 'file=@./input.pdf'
-
-echo-pdf mcp call --tool pdf_extract_pages --args '{"fileId":"<FILE_ID>","pages":[1]}'
-```
-
-### 3.1.2 不上传文件的 URL ingest 流程
-
-如果 PDF 已经在公网可访问，直接传 `url`：
-
-```bash
-echo-pdf mcp call --tool pdf_extract_pages --args '{
-  "url":"https://example.com/sample.pdf",
-  "pages":[1]
-}'
-```
-
-### 3.1.3 stdio MCP（支持本地文件路径）
-
-stdio 模式会把本地 `path/filePath` 自动上传为 `fileId` 后再调用远端工具。
-
-```bash
-echo-pdf mcp-stdio
-```
-
-生成 Claude Desktop/Cursor 等可用的 stdio 配置片段：
-
-```bash
-echo-pdf setup add claude-desktop --mode stdio
-```
-
-### 3.2 给客户端生成 MCP 配置片段
-
-```bash
-echo-pdf setup add claude-desktop
-echo-pdf setup add cursor
-echo-pdf setup add cline
-echo-pdf setup add windsurf
-echo-pdf setup add json
-echo-pdf setup add claude-desktop --mode stdio
-```
-
-`setup add` 输出的是配置片段，把它合并到对应客户端的 MCP 配置文件。
-
-### 3.3 MCP 工具列表
-
-- `pdf_extract_pages`
-- `pdf_ocr_pages`
-- `pdf_tables_to_latex`
-- `file_ops`
-
-MCP 输出策略：
-
-- `pdf_extract_pages` 在 MCP 下默认 `returnMode=url`（不传 `returnMode` 时生效）
-- MCP `text` 会对大字段做去二进制/截断，避免把大段 base64 塞进上下文
-- 二进制结果请优先使用 `resource_link` 中的下载地址
-
-## 4. Web UI 使用
-
-打开：
-
-- `https://echo-pdf.echofilesai.workers.dev/`
-
-流程：
-
-1. 选择 provider。
-2. 点击“测试模型列表”后，选择一个模型。
-3. 上传 PDF。
-4. 选择工具并填写参数（例如 `pages: [1]`）。
-5. 点击 `Run Tool` 或 `Run Stream`。
-
-说明：
-
-- UI 中输入的 key 属于当前会话，不落库到服务端。
-- `returnMode` 支持 `inline`、`file_id`、`url`。
-- `tools/call` 返回统一结构：`{ ok, data, artifacts }`，其中 `artifacts[*].url` 可直接下载。
-- 表格工具返回值会校验并要求包含合法 `tabular`，否则报错。
-
-## 5. HTTP API 使用
-
-### 5.1 上传 PDF
-
-```bash
-curl -sS -X POST https://echo-pdf.echofilesai.workers.dev/api/files/upload \
-  -F 'file=@./sample.pdf'
-```
-
-返回中会拿到 `file.id`。
-
-CLI 等价命令：
-
-```bash
-echo-pdf file upload ./sample.pdf
-```
-
-### 5.2 提取页面图片
-
-```bash
-curl -sS -X POST https://echo-pdf.echofilesai.workers.dev/tools/call \
-  -H 'content-type: application/json' \
-  -d '{
-    "name":"pdf_extract_pages",
-    "arguments":{"fileId":"<FILE_ID>","pages":[1],"returnMode":"inline"},
-    "provider":"vercel_gateway",
-    "model":"google/gemini-3-flash"
-  }'
-```
-
-CLI（默认不自动上传本地文件，需显式开启）：
-
-```bash
-echo-pdf call --tool pdf_extract_pages --auto-upload --args '{"path":"./sample.pdf","pages":[1],"returnMode":"url"}'
-```
-
-说明：
-
-- `echo-pdf call` 默认禁用本地文件自动上传，避免误上传脚枪。
-- 需要自动上传时，显式传 `--auto-upload`，CLI 会回显上传清单（本地路径 -> fileId）。
-- 如果是本地 agent/IDE 场景，优先使用 `echo-pdf mcp-stdio`，它会按 MCP stdio 约定处理 `path/filePath` 自动上传。
-
-下载产物：
-
-```bash
-echo-pdf file get --file-id <FILE_ID> --out ./output.bin
-```
-
-### 5.3 OCR
-
-```bash
-curl -sS -X POST https://echo-pdf.echofilesai.workers.dev/tools/call \
-  -H 'content-type: application/json' \
-  -d '{
-    "name":"pdf_ocr_pages",
-    "arguments":{"fileId":"<FILE_ID>","pages":[1],"provider":"vercel_gateway","model":"google/gemini-3-flash"}
-  }'
-```
-
-### 5.4 表格识别为 LaTeX
-
-```bash
-curl -sS -X POST https://echo-pdf.echofilesai.workers.dev/tools/call \
-  -H 'content-type: application/json' \
-  -d '{
-    "name":"pdf_tables_to_latex",
-    "arguments":{"fileId":"<FILE_ID>","pages":[1],"provider":"vercel_gateway","model":"google/gemini-3-flash"}
-  }'
-```
-
-## 6. 配置与环境变量
-
-统一配置文件：`echo-pdf.config.json`
-
-关键字段：
-
-- `agent.defaultProvider`
-- `agent.defaultModel`
-- `service.publicBaseUrl`
-- `service.fileGet.cacheTtlSeconds`
-- `service.maxPdfBytes`
-- `service.storage.maxFileBytes`
-- `service.storage.maxTotalBytes`
-- `service.storage.ttlHours`
-
-限制关系说明：
-
-- `service.maxPdfBytes`：允许处理的 PDF 最大字节数。
-- `service.storage.maxFileBytes`：文件存储单文件上限（上传 PDF、`url/base64` ingest、以及 `file_id` 结果都会落到存储层）。
-- 当前项目要求 `service.storage.maxFileBytes >= service.maxPdfBytes`，否则配置无效并在启动时报错。
-- 当前默认配置下两者都是 `10000000`（10MB）。
-- 当未绑定 R2、使用 DO 存储时，`service.storage.maxFileBytes` 必须 `<= 1200000`，否则启动会报错。
-- 生产建议始终绑定 R2，并让 DO 只负责协调/元数据，不承载大文件数据。
-
-常用环境变量：
-
-- `OPENAI_API_KEY`
-- `OPENROUTER_KEY` / `OPENROUTER_API_KEY`
-- `VERCEL_AI_GATEWAY_API_KEY` / `VERCEL_AI_GATEWAY_KEY`
-- `ECHO_PDF_DEFAULT_PROVIDER`
-- `ECHO_PDF_DEFAULT_MODEL`
-- `ECHO_PDF_PUBLIC_BASE_URL`（可选，强制 artifacts 生成外部可访问绝对 URL）
-- `ECHO_PDF_FILE_GET_CACHE_TTL_SECONDS`（可选，`/api/files/get` 缓存秒数，`0` 表示 `no-store`）
-- `ECHO_PDF_FILE_GET_AUTH_HEADER` + `ECHO_PDF_FILE_GET_AUTH_ENV`（可选，启用下载端点 header 鉴权）
-- `ECHO_PDF_MCP_KEY`（可选，启用 MCP 鉴权）
-- `ECHO_PDF_WORKER_NAME`（CLI 默认 URL 推导）
-
-鉴权注意：
-
-- 如果配置了 `authHeader/authEnv` 但未注入对应 secret，服务会返回配置错误（fail-closed），不会默认放行。
-- 仅开发调试场景可显式设置 `ECHO_PDF_ALLOW_MISSING_AUTH_SECRET=1` 临时放行“缺 secret”的请求。
-
-## 7. 本地开发与测试
-
-安装与开发：
-
-```bash
-npm install
-npm run dev
-```
-
-测试：
+## Development
 
 ```bash
+npm ci
+npm run build
 npm run typecheck
-npm run test
-npm run smoke
-```
-
-导出真实调用结果到 `fixtures/output`（会先清空输出目录）：
-
-```bash
-INPUT_PDF=./fixtures/input.pdf ./scripts/export-fixtures.sh
+npm run test:unit
+npm run test:acceptance
+npm run test:integration
 ```
 
-## 8. 常见问题
-
-### 8.1 设置了模型但没生效
-
-请确认三处一致：
-
-- CLI 当前 profile 的 `model set` 值
-- 请求里传入的 `model`
-- 实际 provider 的模型列表中存在该 model
-
-当前项目策略是“用户设置的 provider/model 即默认”，不会自动切换到其它模型。
-
-### 8.2 `pdf_tables_to_latex` 返回失败
-
-当前实现要求模型输出中必须包含合法 `\\begin{tabular}...\\end{tabular}`。如果模型返回解释性文本或超时，会直接报错。
-
-### 8.3 `returnMode=url` 如何使用
-
-`url` 模式会把结果落到存储层，并返回一个可直接 `GET` 的下载地址：
-
-- `GET /api/files/get?fileId=<id>`
-
-示例（提取页面并返回 URL）：
-
-```bash
-curl -sS -X POST https://echo-pdf.echofilesai.workers.dev/tools/call \
-  -H 'content-type: application/json' \
-  -d '{
-    "name":"pdf_extract_pages",
-    "arguments":{"fileId":"<FILE_ID>","pages":[1],"returnMode":"url"}
-  }'
-```
+For source-checkout CLI development and repo-local workflows, see [docs/DEVELOPMENT.md](./docs/DEVELOPMENT.md).
 
-### 8.4 错误码语义
+## License
 
-- 客户端输入错误返回稳定 `4xx + code`，例如：
-  - `PAGES_REQUIRED`（400）
-  - `PAGE_OUT_OF_RANGE`（400）
-  - `MISSING_FILE_INPUT`（400）
-  - `FILE_NOT_FOUND`（404）
-- 服务端故障返回 `5xx`。
+Apache-2.0