# @ai-agent-forge/plugin-sdk 中文文档

规范地址：https://npmcn.com/package/%40ai-agent-forge/plugin-sdk/

版本：0\.88\.28
npm 元数据更新时间：2026-11-02T00:56:40.148Z
中文译文更新时间：2026-11-06T00:42:13.189Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ai-agent-forge/plugin-sdk
原文对照：https://npmcn.com/package/%40ai-agent-forge/plugin-sdk/?lang=original
项目主页：https://github.com/agent-forge/agent-forge#readme
源码仓库：https://github.com/agent-forge/agent-forge

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：960 kB，74 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.19\.0
- 运行依赖：1 个
- 首次发布：2026-09-28T16:26:00.205Z
- 最新版本发布：2026-11-02T00:56:39.985Z
- 近 30 天下载量：8056（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：56（近 12 个月 56 个）

## 中文简介

用于代理 Forge 插件的共享插件开发合同(艺术、操作、 diff、 渲染、 上下文预算 DTO)

## 安装

```sh
npm install @ai-agent-forge/plugin-sdk
```

也可以使用：`pnpm add @ai-agent-forge/plugin-sdk`、`yarn add @ai-agent-forge/plugin-sdk`、`bun add @ai-agent-forge/plugin-sdk`

## README

# @ agent-forge/ plugin- sdk (英语)

由一等和第三方代理Forge插件使用的共享,运输中立的合同. 第三方插件开发者安装此软件包作为开发依赖;主机再导出与 `PluginContractsV1`。 。 。 .

## 模块

-   `artifact`数字 : `ArtifactRefV1` 不透明的文物手柄与鉴定.
-   `operation`数字 : `PluginOperationV1`, (中文(简体) ), `PluginResultV1`, (中文(简体) ), `EvidenceRefV1`, (中文(简体) ), `VerificationV1`, (中文(简体) ), `PluginErrorV1`。 。 。 .
-   `diff`数字 : `DiffRequestV1` 编号 : `DiffResultV1` 比较.
-   `render`数字 : `RenderRequestV1` 编号 : `RenderResultV1` 表面渲染.
-   `context-budget`数字 : `projectPluginContextV1` 模式-可见 egress 预算执行.
-   `common`JSON帮助者(`JsonValue`, (中文(简体) ), `stableStringifyV1`, (中文(简体) ), `detachedFreeze`(d) 维护公用事业).

所有验证器冻结其输出并拒绝未知字段,所以验证值是稳定的,在反复运行中具有决定性.

```ts
import { buildArtifactRefV1, type ArtifactRefV1 } from "@agent-forge/plugin-sdk";

const ref: ArtifactRefV1 = buildArtifactRefV1({
  version: 1,
  artifactRef: "artifact:example",
  kind: "screenshot",
  mimeType: "image/png",
});
```

SDK 版本与主机一致 `apiVersion` 里程碑(`插件独立分发与启动装配设计.md` 第4.7节.

## 常见问题

### @ai-agent-forge/plugin-sdk 是什么？

用于代理 Forge 插件的共享插件开发合同\(艺术、操作、 diff、 渲染、 上下文预算 DTO\)

### 如何安装 @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 和提交记录判断。