@atlasauth/pca-openai-agents

中文文档
0.4.3发布于 2026/10/28MITTypeScriptCommonJS近 30 天下载 1793

OpenAI Agents SDK (@openai/agents) guard for PCA: guardrail + tool-execution hook so each agent tool call is proof-carrying + policy-gated.

原始使用文档
文档目录5 节
  1. Install
  2. Usage
  3. API
  4. Status
  5. License

@atlasauth/pca-openai-agents

Guard for the OpenAI Agents SDK (@openai/agents) that makes every agent tool call proof-carrying. withPcaTool wraps a tool so its execute first requires a PCActn (read from the run context), verifies it with the PCA core, and only then runs the original tool; on any failure it throws PcaToolDenied and the tool does not run. Guardrails and needsApproval helpers cover the run-level gate and human or guardian step-up.

The package is duck-typed against the Agents SDK: it has no runtime dependency on @openai/agents and works with any compatible version.

Install

npm i @atlasauth/pca-openai-agents

Depends on @atlasauth/pca and @atlasauth/pca-ai-sdk.

Usage

import { tool, Agent, run } from '@openai/agents';
import { withPcaTool, pcaInputGuardrail } from '@atlasauth/pca-openai-agents';

const refund = tool({ name: 'refund', description: '...', parameters, execute: doRefund });

const guarded = withPcaTool(refund, {
  verify: { grant },              // pcaAgent.grant: the signed Root Intent Grant the proof must chain to
  audience: 'ins_my_server',      // must equal the PCActn's signed aud (null = accept any)
  verb: 'stripe.refund',          // bind the proof to this tool
});

const agent = new Agent({
  name: 'support',
  tools: [guarded],
  inputGuardrails: [pcaInputGuardrail({ verify: { grant }, audience: 'ins_my_server' })],
});

// The agent holding the grant produces the proof (see @atlasauth/pca); it rides on the run context.
const { encoded } = pcaAgent.act('stripe.refund', 'charge:ch_1', toolInput, { aud: 'ins_my_server' });
await run(agent, input, { context: { pca: encoded } });

By default the proof is read from context.pca (or context.pcaProof); pass require to read it from the tool input or elsewhere. verify can also be a function (pcactn) => VerifyResult.

API

  • withPcaTool(tool, options) / pcaTools(record, options) - wrap one tool / a set
  • pcaInputGuardrail(options), pcaToolGuard(options) - Agents SDK guardrails that trip when no valid proof is present
  • pcaNeedsApproval(options), withApproval(tool, options) - map risky tools to the SDK's needsApproval using PCA step-up tiers
  • reviewToolCall(...), pendingStepUps(reviews) - feed an approval inbox
  • PcaToolDenied (with kind: missing | malformed | verify | binding), proofFromRunContext, proofFromInputHeaders

Status

Part of Proof-Carrying Authority. Verification is real (signature, capability chain, plan inclusion, audience, validity window, counter) but is only as strong as the grant and gates you configure. It guards the local agent-execution boundary; when a tool calls a remote service, that service's own verifier remains the authority. PCA's cryptography has not been independently audited.

License

MIT - see LICENSE

版本与发布记录

@atlasauth/pca-openai-agents 共发布 8 个版本,首次发布于 2026/10/08;过去 12 个月发布了 8 个版本。

版本发布日期距今
0.4.3latest2026/10/2811 天前
0.4.22026/10/2613 天前
0.4.12026/10/1227 天前
0.4.02026/10/1227 天前
0.3.02026/10/0930 天前
0.2.02026/10/0930 天前

关于 @atlasauth/pca-openai-agents 的常见问题

@atlasauth/pca-openai-agents 是什么?

OpenAI Agents SDK (@openai/agents) guard for PCA: guardrail + tool-execution hook so each agent tool call is proof-carrying + policy-gated.

如何安装 @atlasauth/pca-openai-agents?

在项目目录运行 npm install @atlasauth/pca-openai-agents,或使用 pnpm add / yarn add / bun add。

@atlasauth/pca-openai-agents 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@atlasauth/pca-openai-agents 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@atlasauth/pca-openai-agents 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@atlasauth/pca-openai-agents 可以商用吗?

@atlasauth/pca-openai-agents 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@atlasauth/pca-openai-agents 的下载量有多少?

根据 npm 官方下载统计,@atlasauth/pca-openai-agents 在 2026/10/07 – 2026/11/05 这 30 天内被下载 1,793 次,日均约 60 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@atlasauth/pca-openai-agents 还在维护吗?

最新版本 0.4.3 发布于 2026/10/28(11 天前);至今共发布 8 个版本,其中过去 12 个月发布了 8 个;首次发布于 2026/10/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。