代理定义
一个编码代理定义的文件格式 。 定义是带有 YAML 前题的 Markdown 文件 。 前事说出代理人为甚么而作. 身体是它的指示.
同一文件意在装入pi-delegate,pi-fabric和pi-prompt-graph,并作为克洛德代码子代理文件工作. 转换器从其他工具导入文件并导出到它们,同时报告每个目标无法保存的内容.
此寄存器持有 schema, 解析器, 验证, 发现规则, 兼容套件, linter, 转换器和一个可持久适配器, 发布为 @centerforagenticai/agent-definitions。 。 。 . 文件/格式.md 描述文件布局、字段、默认和诊断.
npm install @centerforagenticai/agent-definitions
最小定义
---
name: reviewer
description: Use after a change passes its tests, to review one bounded diff for defects.
---
You review one change. Report each defect with the file, the line and a case that fails.
name, (中文(简体) ), description 和身体做一个完整的定义。 其他每个字段都是可选的,并有书面默认.
解析定义
import {
checkIsolation,
checkRuntime,
parseDefinition,
} from "@centerforagenticai/agent-definitions";
import schema from "@centerforagenticai/agent-definitions/schema.json" with { type: "json" };
const parsed = parseDefinition(source, { origin: "project", file: "agents/reviewer.md" });
if (!parsed.ok) {
for (const diagnostic of parsed.diagnostics) console.error(diagnostic.path, diagnostic.message);
} else {
const isolation = checkIsolation({
definition: parsed.definition.workspace.isolation,
requested: "worktree",
});
const runtime = checkRuntime(parsed.definition, {
runtime: "pi-delegate",
knownKeys: ["defaultProgress"],
});
console.log(parsed.definition, parsed.diagnostics, isolation, runtime, schema.$id);
}
parseDefinition 将默认和相容的拼写规范化. 它回来了 ok: false 当诊断有严重性时 error。见 文件/格式.md 所有字段、诊断路径、政策检查和缺省.
命令行
软件包安装 agent-definitions 命令.
npx @centerforagenticai/agent-definitions lint .pi/agents
npx @centerforagenticai/agent-definitions convert --from claude-code --to agent-definitions .claude/agents/reviewer.md
lint 在运行时间加载前检查文件 . convert 除非您通过 --write,并打印出降低的报告.
词汇表
- 代理定义: 描述一个代理的可重用文件 。 不是一个"作用".
- 简介:呼叫者发送的输入用于一个任务.
- 运行:一次执行代理定义.
- 演员: 从定义中创建的长寿运行代理. 运行和演员使用相同的文件;呼叫者选择.
- 示范作用: 名称, 如
role:reviewer只选择一个模式和努力。 运行时的模型配置解决了它. 总是写出"模范角色",从不露出"角色". - 用户角色:对使用应用程序的人进行访问控制。 与代理人定义无关.
- 运行时间:一个装入定义并运行代理的程序,例如pi-delegate,Fabric或Claude Code.
- 适配器:将一次运行连接到此格式的代码.
- 下调报告: 出口商将目标格式降出或被削弱的每个字段写入列表.
发展
使用节点24. 运行 npm install,则 npm run check它运行 Lint、 格式检查、 类型检查、 覆盖测试、 构建测试和包烟测试。 CI执行相同的命令.
文档
- 文件/格式.md:字段,默认,政策检查和诊断.
- 文件/发现: 运行时查找定义文件的地方, 顺序为 .
- 文件/遵守情况:另一个项目如何检查它如何读取相同的定义.
- 文件/日记页:1
lint命令、检查和退出状态. - 文件/转换页:1
convert命令,以及每种外国格式所保存和损失的内容. - 文件/可持久文件: 将定义降低到可持久
configure()输入. - 文件/决定:每个格式的决定及其原因.
- 固定装置/README.md:符合性固定装置和每个复制文件的来源.
状态
0.1版本发运了图案,剖析器,验证,发现和符合套件. 第0.2版增加了: agent-definitions 命令为 lint 财务报告和审定财务报表 convert,用于 Claude 代码、 Codex 、 GitHub 副驾驶、双子CLI 、 OpenCode 和 pi-agents 的转换器,以及 pi-durable 子路径.