Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a0da588f90 | ||
|
|
8ee5d5c467 |
@@ -5,6 +5,8 @@
|
||||
|
||||
参考实现:Dev 仓 `plugins/example`(覆盖全部五类能力,可直接复制改造)。
|
||||
|
||||
契约 v2(声明 / 进程内编译 / sidecar / 前端 ESM,下游仓不得改基座)见提案 `docs/proposals/2026-10-01-plugin-contract-v2.md`。`make plugin-new NAME=<id>` 生成声明式骨架。
|
||||
|
||||
## 1. 目录结构
|
||||
|
||||
```
|
||||
|
||||
@@ -0,0 +1,80 @@
|
||||
# 基座路线图修正:基座不可改,下游独立仓二次开发
|
||||
|
||||
状态:**实施中(2026-10-01)**;owner:weichen;主任务:Dev 仓 `feature/base-extension-roadmap`。
|
||||
规范依据:Development-Guidelines(workflows/delivery.md、standards/collaboration.md);本文是项目级消费,不复制其正文。
|
||||
撰写日期:2026-10-01。
|
||||
|
||||
---
|
||||
|
||||
## 1. 基准
|
||||
|
||||
Agent-System 是通用智能体基座:提供入口、能力、接口和基础功能,并能理解需求、对话、完成任务。页面、功能、工具、技能、MCP、知识库等模组通过插件接入。
|
||||
|
||||
`~/downloads/agent-system-design`(智能研发管理系统,9 篇文档)是**下游特别系统**。它将在一个或多个独立仓库里二次开发,**不得修改基座**。修改基座的唯一合法理由是新增基础能力或扩展接口,路径为:下游提出扩展点申请 → 基座实现并发版 → 下游升级。
|
||||
|
||||
基座只提供引擎、注册点和公开接口。领域数据与领域规则留在下游。延续骨架设计 4.12:知识库是数据,检索引擎是基础设施。
|
||||
|
||||
已拍板且本次不推翻的约束:非容器化、单二进制优先;不迁移老系统资产与数据格式;在途 run 不做透明恢复(标记 `interrupted`,用户重发)。
|
||||
|
||||
## 2. 原差距清单的处置
|
||||
|
||||
对照基准从「两树一网蓝图」改为「通用基座 + 下游不改基座」。原清单编号沿用讨论稿。
|
||||
|
||||
### 2.1 留在基座
|
||||
|
||||
| 编号 | 项 | 本次落点 |
|
||||
|---|---|---|
|
||||
| 3 | 持久化后台任务,与会话锁解耦 | `background_tasks` + `/api/tasks` |
|
||||
| 5 | 仅 cmdbus 待确认态持久化 | `pending_confirms`;run 仍不透明恢复 |
|
||||
| 6 | HITL 超时计时 | `AskHITL` 尊重 `TimeoutSec` |
|
||||
| 8 | 记忆实现 | `memory_entries` + `/api/memory` |
|
||||
| 9 | 默认可选嵌入 | `models.embedding.provider=hash` 本地档;未设置仍按 D23 退化为全文 |
|
||||
| 13 | 通用审计(不含领域依据包) | `audit_events` + `/api/audit` |
|
||||
| 17 | LLM 成本与预算告警 | 日 token 累计,超预算写审计 |
|
||||
| 20 | 命令双入口对拍 | 每个内置命令必须出现在 `command-pairs.json`,否则测试失败 |
|
||||
| 22 | logging / error-code 接线 | 启动日志走 `logging-system`;插件失败带 `sys.unavailable` |
|
||||
| 24 | 依赖边界 lint | `make test-boundaries` 并入 `make test` |
|
||||
|
||||
上下文滚动压缩:`summarizeBeyond=true` 时,窗口外历史改为抽取式摘要注入,不再只丢弃。
|
||||
|
||||
代码执行:沿用已有解释器沙箱(工作区、超时、`runtime.exec` 开关),不另开无沙箱执行器。
|
||||
|
||||
### 2.2 交给下游仓
|
||||
|
||||
版本链与三态关系边、两速管道、文档/切片并发编辑、切片标签 schema、加密与 OCR 档位、ABAC 四元组、审计依据包、飞书业务、通知聚合、领域模板与流程骨架、领域评测指标、三套环境与故障注入、领域导出导入,以及设计文档自己的数据模型欠账。
|
||||
|
||||
基座只提供这些下游会用到的通用口:渠道声明、知识数据集声明、后台任务、审计写入、插件隔离存储、混合检索。
|
||||
|
||||
### 2.3 不采纳
|
||||
|
||||
- 容器编排交付(与骨架「非容器、单二进制」冲突)。
|
||||
- 旧系统资产导入(与「不迁移、不兼容老数据格式」冲突)。
|
||||
- 为单一领域预造版本链、三态边、时间点重建。出现第二个使用方再上提基座。
|
||||
|
||||
## 3. 阶段
|
||||
|
||||
1. **公开扩展面与兼容规则**(本提案第 4 节 + 同日兼容提案)。下游今天必须能依赖基座,而不是 fork。
|
||||
2. **插件契约 v2**(同日插件提案):声明、进程内编译、sidecar、前端 ESM。
|
||||
3. **智能体质量回路**:后台任务、记忆、上下文摘要、本地嵌入档、HITL 超时、确认态持久化、LLM 预算、通用评测夹具。
|
||||
4. **工程基座**:日志与错误码、通用审计、边界 lint、命令对拍、会话导出。
|
||||
|
||||
目标系统薄切片放在 `examples/downstream-rdm`。它只 import 公开包。独立远程仓库由 owner 另行创建;本次不 `git init` 新仓。
|
||||
|
||||
## 4. 公开扩展面(不改模块路径)
|
||||
|
||||
后端业务代码继续留在 `internal/`。新增可导入包:
|
||||
|
||||
- `agent-system-backend/pkg/extension`:进程内注册、宿主 API 客户端、`Main`。
|
||||
- `agent-system-backend/pkg/extension/link`:把 `Main` 接到 `app.Run`(仅基座与下游 main 空白导入)。
|
||||
|
||||
模块路径保持 `agent-system-backend` / `agent-system-core` / `agent-system-ui`。下游 `go.mod` 用 `replace` 指向检出或 Gitea SSH。改成可直接 `go get` 的路径会打断现有全部 import,留到单独发版任务。
|
||||
|
||||
`agent-system-ui` 仍是源码组合(提案 D29:出现第二宿主再发 npm)。本次补上 `exports` 指向的插件 SDK 源文件,不执行 npm 发布。
|
||||
|
||||
公开面版本:`extension.SurfaceVersion = 2.0.0-experimental`。契约快照测试锁定导出符号;增删导出必须改快照。
|
||||
|
||||
版本 tag 与包发布是高后果操作。准备命令见兼容提案,由 owner 确认后执行。本次不打 tag、不推送。
|
||||
|
||||
## 5. 扩展点申请
|
||||
|
||||
下游缺能力时开任务卡,写清:调用场景、希望的公开符号或 HTTP 路径、不改基座时的阻碍。基座只在批准后加公开面并发版。下游禁止提交修改 `internal/` 的补丁作为交付。
|
||||
@@ -0,0 +1,58 @@
|
||||
# 扩展面兼容与演进
|
||||
|
||||
状态:**实施中(2026-10-01)**;owner:weichen;主任务:Dev 仓 `feature/base-extension-roadmap`。
|
||||
撰写日期:2026-10-01。配套:[基座路线图修正](2026-10-01-base-extension-roadmap.md)、[插件契约 v2](2026-10-01-plugin-contract-v2.md)。
|
||||
|
||||
## 1. 版本
|
||||
|
||||
| 面 | 标识 | 规则 |
|
||||
|---|---|---|
|
||||
| 插件清单 | `apiVersion` | 接受 `1.0` 与 `2.0-experimental`。其他值整包拒绝(fail-closed) |
|
||||
| 公开 Go 包 | `extension.SurfaceVersion` | `2.0.0-experimental`。实验窗口内允许破坏性调整,但必须改契约快照并在提案里写一句 |
|
||||
| HTTP API | 路径前缀 `/api/` 与 `/host/v1/` | 已发布路径只加字段,不改语义、不删字段。新能力用新路径 |
|
||||
|
||||
弃用:公开符号先标记注释 `Deprecated:`,至少一个下游可升级的版本之后才删除。实验窗口内的删除仍要改快照测试,不能静默。
|
||||
|
||||
## 2. 兼容窗口对插件清单的具体含义
|
||||
|
||||
- `1.0`:原有 tools/panels/cards/intents/prompts/settings/commands/workspaces 行为不变。`requires.network` 为空时出站仍放行(历史清单没有白名单)。
|
||||
- `2.0-experimental`:同上,并接受 skills、mcpServers、knowledge、parsers、agents、channels、pages、scope、backend。`requires.network` 为空时 **拒绝** 声明式 HTTP 出站。
|
||||
|
||||
新增 JSON 字段一律 `omitempty`,避免 1.0 黄金清单的编码发生变化。
|
||||
|
||||
## 3. 契约快照
|
||||
|
||||
`modules/backend/pkg/extension/surface_test.go` 用 AST 列出 `pkg/extension` 的导出类型与函数,与 `surface.txt` 比较。CI 通过 `make test`(含 `go test ./...`)执行。未更新快照的导出变更会失败。
|
||||
|
||||
依赖边界:`make test-boundaries` 拒绝
|
||||
|
||||
- `pkg/extension` 导入 `agent-system-backend/internal`
|
||||
- 本仓 `examples/` 导入 `agent-system-backend/internal`
|
||||
|
||||
## 4. 下游依赖(replace,本次不改模块路径)
|
||||
|
||||
```
|
||||
require agent-system-backend v0.0.0
|
||||
require agent-system-core v0.0.0
|
||||
|
||||
replace agent-system-backend => ../Agent-System-Dev/modules/backend
|
||||
replace agent-system-core => ../Agent-System-Dev/modules/core
|
||||
```
|
||||
|
||||
后端模块自身的 `replace`(agent-native、logging-system 等)不会被下游继承。下游若编译进 `pkg/extension/link`(会拉起整个后端),需要复制后端 `go.mod` 里的 replace,并把路径改到基座检出。只做声明式插件则不需要 Go 依赖。
|
||||
|
||||
## 5. 发版命令(owner 执行,本次未执行)
|
||||
|
||||
```
|
||||
git tag -a v0.2.0-experimental -m "extension surface 2.0.0-experimental"
|
||||
git push origin v0.2.0-experimental
|
||||
```
|
||||
|
||||
npm 发布 `agent-system-ui` 仍按 D29 推迟到第二宿主出现。不要在实验窗口把 `private` 改成 false 后直接发布。
|
||||
|
||||
## 6. 扩展点申请模板
|
||||
|
||||
- 场景:哪一个下游仓、哪条用户路径走不通。
|
||||
- 希望新增的公开符号或 `/api`、`/host/v1` 路径。
|
||||
- 为何不能用现有注册点、后台任务、审计、KV、命令总线组合出来。
|
||||
- 兼容:加字段还是新路径。
|
||||
@@ -0,0 +1,79 @@
|
||||
# 插件契约 v2
|
||||
|
||||
状态:**实施中(2026-10-01)**;owner:weichen;主任务:Dev 仓 `feature/base-extension-roadmap`。
|
||||
撰写日期:2026-10-01。配套:[路线图](2026-10-01-base-extension-roadmap.md)、[兼容规则](2026-10-01-extension-compat-policy.md)。
|
||||
|
||||
## 1. 四种形态
|
||||
|
||||
下游按需要选一种或组合。基座对四种形态使用同一份 manifest 与同一套 fail-closed:任一资产解析失败则整包拒绝,保留上一状态。
|
||||
|
||||
| 形态 | 下游交付 | 基座职责 |
|
||||
|---|---|---|
|
||||
| 声明 | `plugin.json` + 资产目录 | 注册 tools/skills/mcp/knowledge/parsers/agents/channels/pages/commands/… |
|
||||
| 进程内编译 | 下游 `main` import `pkg/extension` 并 `RegisterCompiled` | `link` + builder 模式产出**下游自己的**单二进制 |
|
||||
| sidecar | 原生进程,manifest `backend.mode=sidecar` | 拉起、健康(进程存活)、停止;环境变量注入 Host API |
|
||||
| 前端 ESM | `pages/*.json` 指向模块 | UI SDK 只暴露命令、SSE 与 `@ui` 组件;页面不得另起设计令牌 |
|
||||
|
||||
进程内编译适合要事务一致性的领域逻辑。sidecar 适合异构语言或强隔离。声明式 HTTP 工具仍然只描述调用,不携带任意代码。
|
||||
|
||||
## 2. manifest 增补
|
||||
|
||||
`apiVersion` 用 `2.0-experimental` 才强制网络白名单。字段见 `modules/core/plugin_v2.go`。
|
||||
|
||||
- `provides.skills`:`skills/<name>.md`,宿主写入 `<data>/skills/plugin-<id>/`。
|
||||
- `provides.mcpServers`:并入小队 MCP 配置(与 `tools.mcp.servers` 合并)。
|
||||
- `provides.knowledge|parsers|agents|channels|pages`:声明登记,供清单 API 与前端加载。
|
||||
- `scope.tenants/projects`:空 = 全部可见。
|
||||
- `backend.command`:sidecar 可执行文件(相对插件目录或 PATH)。`schemaVersion` 记入 `plugin_schema`。
|
||||
|
||||
密钥查找顺序:`secrets.<pluginId>.<authRef>`(按工具执行时的 `OwnerID`),再回落同名全局设置。不再在绑定期固定读 `OwnerDefault`。
|
||||
|
||||
## 3. Host API(sidecar 与外部进程)
|
||||
|
||||
监听由基座在本机拉起,令牌随进程环境变量 `AGENT_HOST_API`、`AGENT_HOST_TOKEN` 下发。
|
||||
|
||||
| 方法 | 路径 | 作用 |
|
||||
|---|---|---|
|
||||
| PUT/GET | `/host/v1/kv/{key}` | 插件隔离 KV(带 owner 与 plugin id) |
|
||||
| POST | `/host/v1/audit` | 写通用审计 |
|
||||
| POST | `/host/v1/commands/{id}` | 走命令总线 |
|
||||
| POST | `/host/v1/llm` | 代理聊天补全;未配置模型返回 503,不静默伪造 |
|
||||
| GET | `/host/v1/knowledge/search` | 混合检索(引擎在基座) |
|
||||
|
||||
插件故障不拖垮基座:sidecar 退出只记日志与审计,不退出主进程。
|
||||
|
||||
## 4. 进程内注册
|
||||
|
||||
```go
|
||||
func init() {
|
||||
extension.RegisterCompiled(extension.InProc{
|
||||
ID: "rdm",
|
||||
Register: func(reg extension.Registry) error {
|
||||
return reg.AddSkill("rdm-note", "# …")
|
||||
},
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
下游 main:
|
||||
|
||||
```go
|
||||
import _ "agent-system-backend/pkg/extension/link"
|
||||
func main() { extension.Main(extension.Options{Addr: "127.0.0.1:8787"}) }
|
||||
```
|
||||
|
||||
## 5. 前端
|
||||
|
||||
`@ui` 导出 `createPluginBridge`:`execCommand` 与 `subscribeEvents`。插件页面模块默认导出 `mount(el, bridge)` / `unmount()`。宿主按 `pages[].module` 动态 `import()`。插件 TSX 与基座一样受 design-guard 约束(令牌、无私人 keyframes、无行内字号)。
|
||||
|
||||
## 6. 生命周期
|
||||
|
||||
- 启用:`POST /api/plugins/{id}/enabled`,按租户记 `plugin_grants`。
|
||||
- 升级:`backend.schemaVersion` 大于已记录版本时调用宿主迁移钩子(KV 命名空间不清空;钩子由进程内扩展提供)。版本只升不降,降级拒绝装载。
|
||||
- 管理面:`GET /api/plugins` 返回 manifest(含 v2 provides)以及技能/页面/渠道声明。既有设置页「插件」分组继续承担热重载。
|
||||
|
||||
## 7. 开发体验
|
||||
|
||||
- `make plugin-new NAME=<id>` 在 `examples/plugins/<id>` 生成声明式骨架。
|
||||
- `examples/plugins/decl-demo`、`examples/downstream-rdm`、`examples/sidecar-demo`、`examples/page-demo` 各覆盖一种形态。
|
||||
- 验收:`examples/downstream-rdm` 的测试不导入 `internal`,并由 `make test-boundaries` 卡住。
|
||||
Reference in New Issue
Block a user