AGENTS.md · git:20260920.3367b72 · 2026-09-20 · sha256 91cf520e7e710d5c
AGENTS.md git:20260920.3367b72A
Immutable. This exact content never changes and is served at /api/v1/blob/91cf520e7e710d5c.
# AGENTS.md — 本仓库浏览与改动导航 这份文件给**进入仓库的代理/协作者**一个最快的心智模型:这里有什么、哪些能碰、哪些绝不能碰、改动会被哪些检查拦截。详细契约见 [`docs/architecture.md`](./docs/architecture.md)。 ## 一句话 这是 **Personal AI 公开发布仓**(机制层:Skill 包 + MCP 发行包 + DSH 插件包 + 质量脚手架;认知层:`soul/` 可携带认知状态 + `host/` 可执行控制宿主),**不是运行时工作区**。根目录 top-level 目录属于七层之一。 ## 分层目录(改动前先认层) | 层 | 目录 | 可否改动 | 改动要点 | |---|---|---|---| | ① Skill 包 | `skills/<name>/`(20 个) | ✅ | 必须登记在 `skills.json`;布局统一 `SKILL.md + agents/openai.yaml + examples/*.md` | | ② MCP 包 | `mcp/<name>/` | ✅ | 登记在 `mcp.json`;自持子目录许可证;`agent-switchboard` 是修改版,非 MIT | | ③ DSH 插件包 | `dsh/<name>/` | ✅ | 本地 DSH 用户级插件:源码 + 可移植 `cordis.patch.yml` 片段 + README 一起发布;不设注册表,校验器不核对 manifest,靠链接/markdown 检查兜底;发布内容禁止含本机路径;`dsh/adapter/` 是 PAI 侧 DSH 身体适配器(依赖方向 dsh → host),`dsh/tests/` 为 L4 契约 + L5/L6 切换演练 | | ④ 质量脚手架 | `scripts/` `tests/` `docs/` `_template/` `.github/workflows/`(`skill-quality-gate` 是 ① 中的 Skill 包,位于 `skills/skill-quality-gate/`) | ✅ | 改 `validate_repo.py` 会影响全部上层契约,谨慎 | | ⑤ 设备运行层 | `.taskflow/` `.grepai/` `.claude/` `node_modules/` 等 | ❌ 禁改/禁提交 | 本地运行态,发布门禁拒绝 | | ⑥ soul/ | `soul/`(`manifest.json` `schema/` `briefing/` `models/` `bootstrap/`) | ✅ | Personal AI 可携带认知状态:通用 L2/L3 脱敏模型 + schema 契约 + briefing 模板 + adopter 骨架;内容只能来自 declassification 链产物或为公开编写的模板,私有 canonical/L0-L1/未脱敏模型禁入;`manifest.json` 是发布锚 | | ⑦ host/ | `host/` | ✅ | Personal AI 中立控制宿主(`docs/pi-migration-design.md`):**零外部依赖**,全目录禁止 import 任何身体/harness(`host/tests/firewall.test.js` 机械执行);运行态写 instance root 禁入仓 | | ⑧ pi/ | `pi/` | ✅ | Pi 身体实现:adapter(Pi API ↔ host 契约)+ bootstrap(唯一 composition root)+ managed extensions;依赖方向恒为 `pi → host`;pin `@earendil-works/*@0.85.1`,lockfile 属 runtime identity | | ⑨ app/ | `app/` | ✅ | Personal AI 自有用户界面层:server(BodySupervisor 多身体组装根 + 零依赖 HTTP/SSE 桥)+ ui(零构建网页:对话 + 身体面板)+ desktop(Electron 壳);**产品级组装根,可同时知道 pi/dsh 入口**;用户经 `body_select` 显式选身体,有会话时走真七态 handoff;`host/` 依然不 import 任何身体 | ## 硬约束(改目录结构的红线) 1. **Skill 统一收在 `skills/<name>/` 下**。`scripts/validate_repo.py::discover_skill_dirs()` 识别 `skills/` 子目录里含 `SKILL.md` 的目录(为兼容也认可根目录平铺的旧包)。新增 Skill 放进 `skills/` 并登记到 `skills.json` 的 `path`(`./skills/<name>`);两处不同步会让 `--strict` 判 FAIL。 2. **两个注册表必须与目录一致**:`skills.json` ↔ `skills/*`;`mcp.json` ↔ `mcp/*`。校验器逐一核对。 3. **发布门禁**:`git diff --check`、`python scripts/validate_repo.py --strict`、`python skills/skill-quality-gate/scripts/quality_report.py --root . --strict`、仓库回归、MCP 回归全绿才可合并。 ## 改动后必须跑的检查 ```bash python scripts/validate_repo.py --strict # 结构 + 注册表 + 许可证 + 链接 + 运行时文件边界 python skills/skill-quality-gate/scripts/quality_report.py --root . --strict # Skill 门禁 python -m unittest discover -s tests -v # 仓库回归 python -m unittest discover -s mcp/agent-switchboard/tests -v # MCP 回归 python -m pytest -c mcp/chatgpt-web-bridge/pyproject.toml mcp/chatgpt-web-bridge/tests -m "not e2e" # ChatGPT bridge 离线回归(先安装该包 .[dev]) npm --prefix host test # host 契约测试(零依赖防火墙) npm --prefix pi test # pi 侧边界测试 npm --prefix dsh test # dsh 身体适配器 L4 契约 + L5/L6 切换演练 npm --prefix app test # app 层:supervisor/bridge 测试(fixture 身体真切换) git diff --check # 空白错误 ``` ## 本地缓存与运行态(当前仓库的"大块头") - `mcp/agent-switchboard/_sdk_probe_deps/` 曾放 Claude Agent SDK 缓存(约 360MB,含打包的 claude.exe)。**已移到** `~/.cache/agent-switchboard-sdk/`,`claude_sdk_backend.py` 从那里探测(可用 `AGENT_BROKER_CLAUDE_SDK_DEPS` 覆盖)。仓库不应再出现这种大体积缓存目录。 - 任何 `state.sqlite`、`.jsonl`、`.log`、用户路径、会话/任务 ID、模型/认证信息都是运行时态,**禁止**由 `mcp.json` 或 CI 校验放行到发布集。 ## 本地经验与跨设备复用入口(新会话/新设备先读这里) 本仓库既是浏览导航,也是**本地特有经验的事实源**。新会话或新设备上第一个会话,先按此索引直达,不重复发明: | 文档 | 用途 | |---|---| | [`BOOTSTRAP.md`](./BOOTSTRAP.md) | **唯一入口种子**:新设备/新会话把一句"读取 BOOTSTRAP.md,自主配置这台电脑"交给 Agent 即可,安装/更新/恢复/同步意图全部固化在内 | | [`docs/sync-ongoing.md`](./docs/sync-ongoing.md) | **优化→同步闭环 SOP**:日常优化流程、跨设备首次/增量同步、各层 SSOT 归属 | | [`docs/publishing.md`](./docs/publishing.md) | 可发布性矩阵(哪些包能进哪些市场)+ 发布检查清单 | | [`docs/local-experience-and-cross-device-reuse.md`](./docs/local-experience-and-cross-device-reuse.md) | 本地特有经验全景总结(治理/插件/技能/证据链)+ 业界做法对照 | 跨设备同步工具:`scripts/sync_skills.py`(技能栈)、`skills/dsh-config-sync`(配置骨架,含 `--template` 路径适配)、`scripts/publish_check.py` / `scripts/run_skill_evals.py`(发布与质量门禁)。凭据纪律:同步/发布永远只带环境变量名引用,`.credentials.yaml` 与运行态绝不出包。