Cadau SDK
本目录按 四类扩展方式 组织代码与文档。选型不确定时先看下表,再进对应子目录。
来源 sdk/README.md
本目录按 四类扩展方式 组织代码与文档。选型不确定时先看下表,再进对应子目录。
| 目录 | 用户说法 | 典型场景 | 代码 | 文档入口 |
|---|---|---|---|---|
host-embed/ | 传软嵌入 | 旧有业务系统挂嵌入助手 | host-embed/widget/ | 可整包交付的对接文档 |
platform-plugin/ | 插件应用 | 应用桌面 iframe 完整 Web | go/ · js/ · contracts/ · templates/ | 平台插件机制与 API |
agent-capability/ | 插件工具 | 消息里调业务能力 API | *规划中* | 技能 + 联网能力包选型 |
appsdk/ | 工作区应用 | 工作区内 app.json 轻量应用 | backend/internal/workspaceapp/ | 界面/handlers/取数规范 |
嵌入挂件浏览器路径仍是 /embed/mindlink-widget.min.js(HTTP 路由,与目录名无关)。
决策树
用户主界面在原有业务系统(传软)?
├─ 是 → host-embed(嵌入助手 + 宿主动作)
└─ 否 → 需要应用桌面里的完整 Web?
├─ 是 → platform-plugin(platform_plugins + mindlink-plugin*)
└─ 否 → 只在消息里调 API / 技能?
├─ 是 → agent-capability(技能 + http_request)
└─ 否 → 工作区内轻量应用?→ appsdk
各目录内容
host-embed(传软嵌入)
- 文档:
host-embed/README.md— 契约、网站集成、宿主知识、HR 范例、宿主 LLM 服务 - 挂件源码:
host-embed/widget/— 构建mindlink-widget.min.js
同步:cd backend && node scripts/sync-embed-sdk.mjs
platform-plugin(插件应用)
| 路径 | 说明 |
|---|---|
platform-plugin/README.md | 机制、知识同步、embed、plugin_invoke、随发技能 |
platform-plugin/go/ | Go SDK(mindlink/sdk/platform-plugin/go) |
platform-plugin/js/ | TS / 浏览器 SDK(@mindlink/plugin-sdk) |
platform-plugin/contracts/ | REST 契约 |
platform-plugin/templates/starter/ | 最小插件骨架 |
Go 引用示例:
require mindlink/sdk/mindlink-plugin v0.0.0
replace mindlink/sdk/mindlink-plugin => ../sdk/platform-plugin/go
agent-capability(插件工具)
对话型能力:不注册 platform_plugins。见 agent-capability/README.md。
appsdk(工作区应用)
工作区轻量应用规范。见 appsdk/README.md。
进一步阅读
- 产品 §4.2.4:产品规格.md
- 文档索引:docs/文档索引.md
- 官方范例:
plugins/hr/、examples/hr-multi-tenant/