SuperAPI AI 工具集

agents-md

编程与开发

查看项目

更新于 10-15 17:24

技能介绍

用途:编写、精简或审计仓库中的代理指令文件(AGENTS.md、CLAUDE.md 等),这类文件会在每次会话开始时被加载,因此其篇幅预算是最稀缺的资源。作者认为它的任务不是描述仓库,而是承载那些称职代理本来会做错的关键信息。

两种模式:可信编写或审计(自己的仓库,或愿意运行 bin/setup 的仓库,允许本地可逆验证)与不可信审计(他人的仓库,仅静态检查,需遵守 references/spec.md 的隔离规则)。只有操作者明确指示才进入可信模式,不得推断。

逐行分类:OBVIOUS(可从 ls、--help 或框架惯例推导)应删除;GOTCHA(仓库特有、非显而易见)保留并以失败模式优先表述;TASTE(代码不可推导)仅在反直觉时保留,写成带理由的默认值;POINTER 指向需要偶尔深入了解的路径。

风格规则:按可恢复性而非重要性分区。可由模仿恢复的(方法顺序、命名约定等)删除;模仿是陷阱的(遗留模式)必须常驻;反直觉的用文字说明;被 CI 强制但未记录的优先保留。规则写成默认值加理由,绝对化措辞仅用于不可逆、数据丢失、安全或硬性 CI 门禁。

验证:始终静态解析所有路径、链接和示例,从定义文件读取端口、版本和常量;可信模式下还需确认每条文档化的命令真实存在。不得为验证而运行部署、数据库重置、写共享服务、花钱或携带凭据的命令,只能读源码、--help 或 --dry-run。

预算:默认约 100 行、2.5k 常驻 token,作为审查阈值而非硬性配额。不包含 PR 编号等易过期内容。该技能不附带验证器,理由是不可信模式下解析攻击者控制的输入风险高于明文规则。