@agent-forge/plugin-sdk
Shared, transport-neutral contracts used by first-party and third-party Agent Forge plugins. Third-party plugin developers install this package as a development dependency; the host re-exports the same modules as PluginContractsV1.
Modules
artifact: ArtifactRefV1 opaque artifact handles and validation.
operation: PluginOperationV1, PluginResultV1, EvidenceRefV1, VerificationV1, PluginErrorV1.
diff: DiffRequestV1 / DiffResultV1 comparisons.
render: RenderRequestV1 / RenderResultV1 surface rendering.
context-budget: projectPluginContextV1 model-visible egress budget enforcement.
common: JSON helpers (JsonValue, stableStringifyV1, detachedFreeze, assertion utilities).
All validators freeze their output and reject unknown fields, so validated values are stable and deterministic across repeated runs.
import { buildArtifactRefV1, type ArtifactRefV1 } from "@agent-forge/plugin-sdk";
const ref: ArtifactRefV1 = buildArtifactRefV1({
version: 1,
artifactRef: "artifact:example",
kind: "screenshot",
mimeType: "image/png",
});
SDK versions align with the host apiVersion milestones (插件独立分发与启动装配设计.md §4.7).
关于 @ai-agent-forge/plugin-sdk 的常见问题@ai-agent-forge/plugin-sdk 是什么? Shared plugin development contracts (artifact, operation, diff, render, context budget DTOs) for Agent Forge plugins
如何安装 @ai-agent-forge/plugin-sdk? 在项目目录运行 npm install @ai-agent-forge/plugin-sdk,或使用 pnpm add / yarn add / bun add。
@ai-agent-forge/plugin-sdk 支持 TypeScript 吗? 支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@ai-agent-forge/plugin-sdk 支持 ESM 还是 CommonJS? 以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@ai-agent-forge/plugin-sdk 需要什么版本的 Node.js? package.json 的 engines 字段要求 Node.js >=22.19.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@ai-agent-forge/plugin-sdk 可以商用吗? @ai-agent-forge/plugin-sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@ai-agent-forge/plugin-sdk 的下载量有多少? 根据 npm 官方下载统计,@ai-agent-forge/plugin-sdk 在 2026/10/05 – 2026/11/03 这 30 天内被下载 8,056 次,日均约 269 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@ai-agent-forge/plugin-sdk 还在维护吗? 最新版本 0.88.28 发布于 2026/11/02(4 天前);至今共发布 56 个版本,其中过去 12 个月发布了 56 个;首次发布于 2026/09/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。