跳转至

公共 API 参考

本目录为 Skill Family Foundation 三包建立机器可读能力目录(docs/agents/capability-catalog.json)的人类可读投影。范围按 hand-off §4.3:优先从真实导出核对,不手写无法证明新鲜度的 API 全集。

覆盖范围

页面 公共入口性质
skill-family-contracts contracts.md 机器契约、协议、错误码、fixture、审计表面(纯函数为主)
skill-family-harness-node harness.md 业务中立 Node 机制(收容、原子写、闭包、请求、报告、状态底座)
skill-family-engineering-kit engineering-kit.md 四个顶层命令与只读/受控写子动作

每个公共入口按 §4.3 至少说明:签名与输入输出、是否纯函数、文件/进程/Git/网络副作用、稳定错误码与 details.kind、前置条件与信任锚、sincestability、源文件与正例/负例测试、调用方仍拥有的业务语义。

与机器事实层的关系

  • 能力稳定 ID(如 foundation.contracts.object-validationfoundation.harness.state-store)定义在 docs/agents/capability-catalog.json,本页从中投影并链接回 sourceRefs 与测试引用。
  • 本页签名取自各包 src/index.mjs 与源模块真实导出;门禁 scripts/docs/capability-catalog-check.mjs 解析 src/index.mjs,拒绝 catalog 引用不存在的入口。
  • catalog 是文档层机器事实,不是新的 Contracts 公共对象或协议;未经 ADR 不得为写文档新增第四包或 Contracts 对象。

关键纪律

  • 机制失败统一 SFC2004EXECUTION_FAILED),由 details.kind 区分(HARNESS_ERROR_KINDS 冻结枚举);Contracts 校验失败(SFC1001 / SFC1002)经 validateDocument 返回值表达、不抛异常。
  • Kit 顶层命令集合固定为 4 个(scaffold / adopt-plan / projection / check),不扩张;远端或通用 host apply、删除式 uninstall、Qoder 完整 driver、二进制 adapter source、远端发布、业务状态机、模型编排、领域审计语义均明确 unsupported。已登记宿主的本地 install/update 仅通过受授权的 plan API 提供。
  • 所有版本字段从 package.json 与 Contracts 真源生成或由 fact-check 校验;CONTRACTS_VERSION=1.4.0 与 npm 包版本 0.3.0 并行。

Quickstart Profile v2 candidate

三个包都通过既有 candidate 子路径公开 Quickstart Profile v2。Contracts 定义 execute-method 交换结构,Harness 复验字节和绑定,Kit 从显式消费者 Schema 生成离线 Bundle。该能力仍标记为 candidate,0.3.0 的 v2 与 0.2.1 的 v1 不兼容;消费者必须精确锁定所选包版本。