Effect 中文文档 MCP server

Effect 中文社区

站点： —— Effect（TypeScript 的 effect system）官方文档全量中文翻译

（v4 + v3 共 234 页，每页标注上游基线）+ 可溯源的问答（每条引用可点回原文，无依据即拒答）

+ 报错百科（真实报错的检索索引）+ 26 个用 Effect 写的开源 AI 项目推荐。

给 AI / Agent 的入口：/llms.txt · /llms-full.txt · /docs/.md · /cite/.json（引用核验记录）

· MCP server（仓库内 pnpm mcp）。

中文世界 Effect 的第一入口：官方文档的高质量中文译站 + 内容社区 + 由 Effect 与 DDD 自建的开源标本。

上线步骤见 docs/deployment.md。

• 产品与技术规划见 PLAN.md；译者规范见 docs/translation-guide.md；

每篇 frontmatter 记录译者 / 审校 / 上游基线；搜索、RSS、llms.txt 全部为构建期产物，不依赖后端。

• 站点当前状态：已具备公开发布条件 —— v3 + v4 全量 234 篇中文译文（v4 110 · v3 124，覆盖率 100%），

（代码块与上游逐字节一致、结构对齐、术语 0 命中、锚点可达），非人类精读，尚无人类精读署名； 展示口径见 apps/site/src/data/provenance.ts，维护者精读抽查后请追加自己的名字。

• 审校口径：当前 234 篇的 reviewers 一律为 ecn-review，含义是机器可复核

快速开始

pnpm install

# 一条命令跑起前后端（Astro 前台 :4321 + Effect API :8787）
pnpm dev

# 可选：接入模型（不配也能完整运行 —— extractive 模式：检索合成 + 引用 + 拒答，零成本）
cp .env.example .env                      # 填 DEEPSEEK_API_KEY=sk-...（或 LLM_BASE_URL + LLM_API_KEY）
pnpm --filter @ecn/api llm:check          # 一条命令验证模型真的接上了（打印提供方/模型/超时）
# 查找顺序：apps/api/.env.local → apps/api/.env → 仓库根 .env.local → 仓库根 .env
# `pnpm dev` 会 watch 这几个文件：改完 Key 自动重启，不用手动重启

# 可选：本地 Postgres（默认 InMemory 模式不需要它）—— 在 .env 里设置 DATABASE_URL 后：
pnpm db:up                                # docker 起 Postgres；或用本机 postgres 亦可

• 前台：（/api/* 已由 dev 代理到后端）
• 后端：
• GET /api/health 健康检查
• GET /api/questions 问题列表 / POST /api/questions 提问 / GET /api/questions/:id 详情
• GET /openapi.json 自动生成的 OpenAPI（来自 @effect/schema 契约）

常用命令

pnpm typecheck            # 全仓类型检查（含 astro check）
pnpm test                 # 各包测试（api: domain/application；content: 内容门禁）
pnpm build                # contracts 编译 + api typecheck + astro 构建
pnpm content:check        # 内容门禁：frontmatter / 路径镜像 / 术语 / 元数据残留（PR 必过）
pnpm cite:check           # 引用协议门禁：摘要 / 内容指纹 / 构建产物一致（保证引用可解引用）
pnpm proposals:check      # Agent 提案队列校验：治理不变量 + 复用内容门禁
pnpm content:status       # 译文同步状态扫描
pnpm corpus:build         # 生成 AI 知识层语料（内容改动后必跑；CI 有新鲜度门禁）
pnpm mcp                  # 启动 MCP Server（stdio），把中文知识接进编码 Agent
pnpm report:weekly        # 周报：AI 用量 / 可验证答率 / 缓存命中 / Agent 侧下载量（见 docs/metrics.md）
pnpm traffic              # 访问报表（宿主 Caddy 日志；`pnpm traffic:prod` 从生产拉取）
pnpm --filter @ecn/api llm:check   # 用真实模型跑一次问答+报错诊断（验证 DeepSeek/OpenAI 兼容配置）
# 上游相关（需先 clone 官方内容仓库；路径用绝对路径）
pnpm --filter @ecn/content exec tsx src/cli.ts snapshot --dir <上游docs> -o snap.json
pnpm --filter @ecn/content exec tsx src/cli.ts diff --snapshot /abs/snap.json --docs /abs/apps/site/src/content/docs
pnpm --filter @ecn/content exec tsx src/cli.ts nav --dir <上游docs> -o apps/site/src/data/docs-nav.json

站点具备什么

Shortened. The full README is on GitHub.