Skip to content

架构文档索引

本目录是 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 Routerpackages/host/router/src/
Host APIpackages/host/api/src/

用户向补充

若你刚接触 Agent / MCP,建议先读 Agent 概念入门MCP 集成,再回来查阅本目录下的契约文档。

基于 MIT 许可发布