Documentation Map
Developer handbook (中文): project structure, Graph/Loop, tools, MCP, skills, database algorithms and Worker extensions.
Start with the architecture and development guides, then follow the references for Worker communication, configuration, and capability extensions. Every guide is available in English and Simplified Chinese.
Guides
| Document | English | 简体中文 | Contents |
|---|---|---|---|
| npm package guide | Read | 阅读 | Installation, public API, real model, Redis/Memory, complete examples and consumer verification |
| Project overview | Read | 阅读 | Project goals, capabilities, and setup |
| Architecture | Read | 阅读 | Worker ownership, internal Nodes, Graph/Loop execution, scaling, and module boundaries |
| Development and Integration | Read | 阅读 | Installation, checks, package entry points, and custom Workers and Nodes |
| Implemented Worker APIs | Read | 阅读 | CONTEXT, INFER, MEMORY, INTERACTION and optional RETRIEVAL APIs |
| Runtime / Graph / Loop | Read | 阅读 | Graph bindings, loops, worker services, IPC / HTTP |
| Checkpoints and budgets | Read | 阅读 | Portable Graph/Loop state, isolated branches, token admission and settlement |
| Worker Communication | Read | 阅读 | Local and remote calls, HTTP deployment, lifecycle, events, and artifacts |
| Interaction and Runtime Configuration | Read | 阅读 | Providers, models, credentials, tools, MCP, Skills, and Sandbox permissions |
| Node Taxonomy and API Contract | Read | 阅读 | Final capability tree, common public types, 21 executable leaf Contracts, and Runtime predefined flows |
| Node Coverage | Read | 阅读 | Current 21 Core leaves, optional retrieval and practical call chains |
| Worker composition / 组合 | Read | 阅读 | Node/Worker、resources/dispose、EventFabric、ArtifactStore、PayloadCodec |
| Predefined flows / 预定义流程 | Read | 阅读 | RAG / Skill / Tool / MCP / ReAct |
| Configuration / 配置 | Read | 阅读 | YAML/env、参数分组、优先级、显式加载 |
The environment variable template uses bilingual comments.
Source Reference
| Source | Guide |
|---|---|
src/contracts/ | Architecture: shared data types and the Node contract interface |
src/worker/*/contracts.ts, src/worker/node.ts | Development and Integration: Worker-owned contracts and typed handlers |
src/worker/define-worker.ts, src/runtime/graph.ts, src/runtime/router.ts | Architecture: composition, execution, and routing |
src/runtime/loop.ts | Architecture: state, per-round Graph selection, and bounded execution |
src/runtime/communication/, src/runtime/artifact.ts | Worker Communication |
src/runtime/config.ts, src/runtime/services.ts, src/runtime/sandbox/ | Interaction and Runtime Configuration: configuration and permissions |
src/worker/infer/providers/ | Interaction and Runtime Configuration: vendor-neutral model Provider adapters |
src/worker/interaction/ | Interaction and Runtime Configuration: leaf tool/MCP capabilities and application Graph + Loop composition |
Language Convention
Use .md for English and .zh-CN.md for Simplified Chinese. Each document links to its counterpart at the top. Update both versions together, preserving matching sections, API definitions, and examples. Keep navigation focused on user-facing documentation.