架构文档索引
本目录是 Zhin.js 架构与契约 的入口。修改 IM 消息链或出站路径时,先读此处再改代码。
IM 主栈(Stable)
默认开发与对外承诺范围以 examples/minimal-bot 为准。
| 文档 | 说明 |
|---|---|
| 架构概览 | 分层(basic → kernel → ai → core → agent → zhin)、消息流程图 |
| 仓库结构 | pnpm workspace、src→lib / client→dist |
| Harness 工程 | 发送链路、层级依赖、CI 检查 |
| Agent 上下文块 | 系统提示词分段与贡献者约定 |
| Agent 提示词贡献者 | 平台专属 AgentPromptContributor |
| HTTP 路由编写 | Koa Router / registerFetchRoute 兼容 API |
根目录 AGENTS.md 为 AI 编码代理的最小入口。
代码锚点
| 用途 | 路径 |
|---|---|
| 插件 / 命令 / 中间件 | packages/im/core/src/plugin.ts |
| 适配器与发送 | packages/im/core/src/adapter.ts |
| 消息调度 | packages/im/core/src/built/dispatcher.ts |
| 出站字段规范化(cron 等) | packages/im/core/src/built/queue-im-field-contract.ts |
| Agent 编排 | packages/im/agent/src/orchestrator/ |
| 安全策略 | packages/im/agent/src/security/ |
| AI 引擎 | packages/im/ai/src/agent/ |
| Host Router | packages/host/router/src/ |
| Host API | packages/host/api/src/ |
用户向补充
若你刚接触 Agent / MCP,建议先读 Agent 概念入门 与 MCP 集成,再回来查阅本目录下的契约文档。