文档地图
开发者搭建手册：从项目结构、Graph/Loop 到 Tool、MCP、Skill、数据库算法与 Worker 扩展。
建议先读架构和开发指南，再按需要阅读 Worker 通信、配置和能力扩展文档。所有指南均提供英文与简体中文版本。
指南
| 文档 | English | 简体中文 | 内容 |
|---|---|---|---|
| npm 包基础使用 | Read | 阅读 | 从空目录安装、公开 API、真实模型、Redis/Memory、完整示例与包外验收 |
| 项目概览 | Read | 阅读 | 项目目标、能力与环境准备 |
| 架构 | Read | 阅读 | Worker 归属、内部 Node、Graph/Loop 执行、扩容与模块边界 |
| 开发与接入 | Read | 阅读 | 安装、检查、包入口以及自定义 Worker 和 Node |
| Worker API（已实现） | Read | 阅读 | CONTEXT、INFER、MEMORY、INTERACTION 与可选 RETRIEVAL 的详细接口及调用 |
| Runtime / Graph / Loop | Read | 阅读 | Graph bindings, loops, worker services, IPC / HTTP |
| 检查点与预算 | Read | 阅读 | Graph/Loop 可移植状态、隔离分支、token 准入与结算 |
| Worker 通信 | Read | 阅读 | 本地与远程调用、HTTP 部署、生命周期、事件与 Artifact |
| 交互与运行配置 | Read | 阅读 | Provider、模型、凭证、工具、MCP、Skill 和 Sandbox 权限 |
| 节点体系与 API Contract | Read | 阅读 | 最终能力树、公共基础类型、21 个可执行叶子 Contract 与 Runtime 预定义流程 |
| 节点体系覆盖 | Read | 阅读 | 当前 21 个 Core 叶子、可选检索及常见调用链 |
| Worker composition / 组合 | Read | 阅读 | Node/Worker、resources/dispose、EventFabric、ArtifactStore、PayloadCodec |
| Predefined flows / 预定义流程 | Read | 阅读 | RAG / Skill / Tool / MCP / ReAct |
| Configuration / 配置 | Read | 阅读 | YAML/env、参数分组、优先级、显式加载 |
环境变量模板 使用双语注释。
源码索引
| 源码 | 指南 |
|---|---|
src/contracts/ | 架构：共享数据类型与 Node 契约接口 |
src/worker/*/contracts.ts、src/worker/node.ts | 开发与接入：Worker 自有契约与类型化 handler |
src/worker/define-worker.ts、src/runtime/graph.ts、src/runtime/router.ts | 架构：组合、执行与路由 |
src/runtime/loop.ts | 架构：状态、逐轮选图与有界执行 |
src/runtime/communication/、src/runtime/artifact.ts | Worker 通信 |
src/runtime/config.ts、src/runtime/services.ts、src/runtime/sandbox/ | 交互与运行配置：配置与权限 |
src/worker/infer/providers/ | 交互与运行配置：供应商中立的模型 Provider adapter |
src/worker/interaction/ | 交互与运行配置：工具/MCP 叶子能力、Skill 上下文加载与应用 Graph + Loop 组合 |
双语约定
英文使用 .md，简体中文使用 .zh-CN.md。每篇文档顶部提供对应语言的链接。修改时同步两种语言，保持章节、API 定义与示例一致。导航仅收录面向使用者的文档。