API 参考

生命周期

createAgentHarness(...)
stop(...)
subscribe(...)

最小启动示例

import { createAgentHarness, stop } from "@botbotgo/agent-harness";

const runtime = await createAgentHarness("/absolute/path/to/workspace");
await stop(runtime);

请求执行

request(...)
cancelRequest(...)
normalizeUserChatInput(...)

用 request(...) 发起一次请求。如果你的产品本来就是 chat-style multimodal 输入，可以用 normalizeUserChatInput(...) 做转换。

检查与运行查询

getHealth(...)
getOperatorOverview(...)
listRequests(...)
getRequest(...)
listSessions(...)
getSession(...)
listApprovals(...)
getApproval(...)
listRequestEvents(...)

审批

resolveApproval(...)

审批通过运行时 API 处理即可，不需要直接碰 checkpoint 内部逻辑。

运行时 memory

memorize(...)
recall(...)
listMemories(...)
updateMemory(...)
removeMemory(...)

这些 helper 提供稳定的 memory 接口，而 merge、projection rebuild、vector indexing 和存储布局仍由 runtime 内部处理。

Artifacts 与导出包

listArtifacts(...)
getArtifact(...)
recordArtifact(...)
exportRequestPackage(...)
exportSessionPackage(...)
exportEvaluationBundle(...)
replayEvaluationBundle(...)

当 CI、离线评估或管理工具需要稳定的运行证据时，优先使用这些导出 helper，而不是直接访问持久化内部结构。`recordArtifact(...)` 允许应用把 product spec、sprint contract、QA report 这类 app-owned 文件挂到同一个持久化 run surface 上，再统一导出。

协议与传输适配

createAcpServer(...)
createAcpStdioClient(...)
serveAcpStdio(...)
serveAcpHttp(...)
serveA2aHttp(...)
serveAgUiHttp(...)
createRuntimeMcpServer(...)
serveRuntimeMcpOverStdio(...)
createToolMcpServer(...)
serveToolsOverStdio(...)

当 IDE、CLI、远程客户端或其他智能体运行时希望接入本运行时，又不想直接依赖内部模块时，使用这些适配器。

当 IDE 或 CLI sidecar 需要通过 stdio 使用 newline-delimited ACP JSON-RPC，又不想自己重写 line parsing 时，使用 createAcpStdioClient(...) 作为最小 reference client。

打开协议接入指南 →

Flow inspection 工具

exportFlow(...)
exportSequence(...)
createUpstreamTimelineReducer(...)

这些 helper 是 inspection 工具，不是第二套执行协议。它们的职责是把 runtime events 和可选 upstream traces 变成可视化材料。

Inventory 与发现 helper

describeInventory(...)
getAgent(...)
listAgentSkills(...)

适合用来做运行时加载结果展示，以及说明每个 agent 当前拥有哪些能力。

管理 helper

deleteSession(...)

当某个已完成 session 需要从运行时表面显式移除时，使用 deleteSession(...)。