返回列表

AGENTS.md|面向AI编程智能体的代码库文档规范

一种为 AI 编程智能体编写的代码库文档规范,用结构化上下文、指令与约束告诉智能体项目怎么用、哪些不能碰,适合维护开源仓库或团队项目的开发者。

代码审查与开发辅助上下文工程AI编程智能体仓库文档开发规范站长实测状态尚未登记

工具介绍

用途

AGENTS.md 是专门为 AI 编程智能体设计的代码库文档开放标准。它把项目背景、构建与测试方式、编码约定和禁止事项写成结构化说明,存放在代码库里,让智能体接手任务时先读懂规则再动手。

适用人群

  • 在仓库中频繁使用 AI 编码智能体的开发者;
  • 需要统一团队内 AI 协作方式的工程团队;
  • 维护开源项目、希望外部贡献者的智能体也能遵循约定的维护者。

已知能力(据来源描述)

  • 提供结构化上下文、指令与约束;
  • 目标是让智能体更高效、更安全地工作;
  • 以“文件放在代码库中”的形式被智能体读取。

使用步骤(通用参考)

  1. 在项目根目录创建 AGENTS.md;
  2. 写明项目定位、技术栈、目录结构与常用命令;
  3. 列出编码风格、测试要求与依赖管理方式;
  4. 明确禁止操作,如不得改动的目录、不得提交的凭证;
  5. 在支持读取该文件的智能体环境中验证其是否被正确识别。

内容建议

  • 命令写全,避免智能体猜测;
  • 约束尽量可验证;
  • 项目变更后同步更新文档。

限制与待核查

  • 该规范被多少智能体工具原生支持:待核查;
  • 规范细节与命名要求:以项目文档为准;
  • 项目许可:待核查,需查阅项目独立条款,导航资料的 CC-BY-4.0 不适用于该规范;
  • 实际提升效果:未实测,不作成效承诺。

提示

文档中不要写入真实密钥或敏感路径。

来源与使用边界

原始入口:https://github.com/agentsmd/agents.md

整理来源:https://github.com/ikaijua/Awesome-AITools

依据来源资料经AI翻译整理,未由本站实测。原始资料许可:CC-BY-4.0;目录许可不代表各产品或文件的使用授权。费用、账号、国内访问与版本兼容条件以原始发布者最新说明为准。

运行与适配

使用难度
如何理解使用难度?
  • 直接使用:通常打开网页或登录账号即可使用。
  • 简单配置:需要填写密钥、连接服务或导入配置。
  • 需要部署:需要安装依赖、配置运行环境或自行部署。
  • 技术开发:需要编程、接口集成或开发调试。

格数越多,使用门槛越高;具体要求请看下方说明。

代码仓库(与AI编程智能体配合使用)

需所用智能体能够读取仓库内的说明文件;支持范围待核查

访问来源 ↗

国内使用情况与网友核验

网友核验 用户经验分享

与站长实测独立,不代表官方认证或本站已实测。

我要核验
0 位参与者0 份有效分项记录

最近核验:暂无有效核验。参与人数按当前项目有效身份去重;不同核验项分别统计,不合并成用户总结果。仅统计审核通过且未过期的记录。

分项统计、有效期与样本量
核验项目有效人数成功 / 部分 / 失败 / 无法判断成功率最近核验 / 有效期
官方网站访问00 / 0 / 0 / 0样本不足暂无 / 7 天
GitHub 仓库访问00 / 0 / 0 / 0样本不足暂无 / 7 天
安装与运行00 / 0 / 0 / 0样本不足暂无 / 30 天
官方服务国内连接 / MCP 连接00 / 0 / 0 / 0样本不足暂无 / 30 天
国内网络情况00 / 0 / 0 / 0样本不足暂无 / 7 天
国内模型兼容性00 / 0 / 0 / 0样本不足暂无 / 30 天
自定义 API00 / 0 / 0 / 0样本不足暂无 / 30 天
海外服务依赖
00 / 0 / 0 / 0样本不足暂无 / 30 天
海外账号要求
00 / 0 / 0 / 0样本不足暂无 / 30 天
中文界面
00 / 0 / 0 / 0样本不足暂无 / 30 天
客户端兼容性00 / 0 / 0 / 0样本不足暂无 / 30 天
账号及费用信息
00 / 0 / 0 / 0样本不足暂无 / 30 天

成功率 = 成功 ÷(成功 + 部分成功 + 失败);无法判断不计入分母。至少 5 份可判断结果才显示成功率。账号、费用、海外依赖与语言等事实项,成功表示核查结论与资料吻合,具体观察另行统计;不表示免费或没有海外依赖。不同网络、客户端和版本的结果不能直接等同。

最近有效核验

暂无审核通过且未过期的网友核验。欢迎提交真实使用记录。

查看全部有效核验 →

反馈此内容的问题