awesome-agent-conventions

<!-- 由脚本 scripts/build_readme.py 生成 - 请勿手动编辑。 --> <!-- 编辑 scripts/targets.json（或按约定编辑页面），然后重新运行脚本。 --> <p align="center"> <img src="assets/hero.png" alt="Awesome Agent Conventions - convention files for AI agents" width="100%"> </p> # 精彩代理约定 <p align="center"> <a href="https://awesome.re"><img src="https://awesome.re/badge.svg" alt="精彩"></a> <a href="https://github.com/ItamarZand88/awesome-agent-conventions/actions/workflows/verify.yml"><img src="https://github.com/ItamarZand88/awesome-agent-conventions/actions/workflows/verify.yml/badge.svg" alt="验证"></a> <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="许可证：MIT"></a> </p> **精选的人工智能代理约定文件指南。** **涵盖 11 类别下的 21 项约定。** 从常见的项目指令文件到较新的代理-网页发现和信任格式。 代理工具越来越多地依赖于存储库或网站根目录中的普通文件： 指令、内存、规则、工具连接、提示资产、发现元数据和协议提示。 文件名很容易混淆，而且采用程度差异很大。 本仓库保持地图实用： - **了解文件用途。** 每个条目都指明了约定、通常的文件名、主要读取者以及规范或来源。 - **研究真实示例。** 示例由脚本从公共存储库获取，并在每个文件的顶部保留出处。 - **将实践与提议分开。** 成熟度标签显示了哪些是广泛使用的，哪些是早期，哪些仍然只是提议。 ## 目录 - [指令与上下文](#指令与上下文) · [分类页面](categories/instruction-context.md) - 🟢 [AGENTS.md](conventions/agents-md/) - 🟢 [CLAUDE.md](conventions/claude-md/) - 🟢 [特定工具指令文件](conventions/tool-specific-instructions/) - [内存与状态](#内存与状态) · [分类页面](categories/memory-state.md) - 🟢 [MEMORY.md](conventions/memory-md/) - 🟢 [内存库](conventions/memory-bank/) - [规范驱动开发](#规范驱动开发) · [分类页面](categories/spec-driven-development.md) - 🟢 [规范套件](conventions/spec-kit/) - 🟢 [Kiro 控制文件](conventions/kiro-steering/) - [技能与提示资产](#技能与提示资产) · [分类页面](categories/skills-prompt-assets.md) - 🟢 [SKILL.md](conventions/skill-md/) - 🟢 [提示资产文件](conventions/prompt-assets/) - 🟢 [Claude 代码命令](conventions/claude-commands/) - 🟢 [Copilot 提示与指令文件](conventions/copilot-prompt-files/) - [工具与连接](#工具与连接) · [分类页面](categories/tooling-connections.md) - 🟢 [MCP 服务器配置](conventions/mcp-config/) - [规则与忽略文件](#规则与忽略文件) · [分类页面](categories/rules-ignore-files.md) - 🟢 [规则文件](conventions/agent-rules/) - 🟢 [AI 忽略文件](conventions/ai-ignore-files/) - [设计](#设计) · [分类页面](categories/design.md) - 🟢 [DESIGN.md](conventions/design-md/) - [网页与可发现性](#网页与可发现性) · [分类页面](categories/web-discoverability.md) - 🟢 [llms.txt](conventions/llms-txt/) - 🟢 [pricing.md](conventions/pricing-md/) - [代理-网页信任](#代理-网页信任) · [分类页面](categories/agent-web-trust.md) - 🟠 [auth.md](conventions/auth-md/) - 🔵 [ai.txt](conventions/ai-txt/) - [身份与协议](#身份与协议) · [分类页面](categories/identity-protocols.md) - 🟠 [代理卡（A2A）](conventions/agent-cards/) - [提议的命名空间](#提议的命名空间) · [分类页面](categories/proposed-namespace.md) - 🔵 [protocols.md 命名空间](conventions/protocols-md/) ## 什么算数 本列表故意范围狭窄。 当文件是代理行为或代理可读元数据的约定时，它才属于这里：指令、内存、技能、规则、工具配置、提示资产或网页发现提示。 任何文件类型都可以合格 - `.md`、`.txt`、`.prompty`、`.json`、点文件或目录模式。 人类优先的项目文档如 `README.md`、`CONTRIBUTING.md`、`SECURITY.md` 和 `CHANGELOG.md` 保持不变，除非文件本身已成为代理约定。 ## 成熟度等级 徽章是对采用情况的声明，而不是质量。 它将已证明的约定与新想法区分开来。 | 徽章 | 等级 | 含义 | | --- | --- | --- | | 🟢 | **已采用** | 已被多个工具、项目或团队在生产环境中使用。 | | 🟠 | **新兴** | 由真实组织发布，但仍处于早期或采用有限。 | | 🔵 | **提议** | 已公开描述，但除提议外没有明确采用。 | ## 指令与上下文 独立页面：[categories/instruction-context.md](categories/instruction-context.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [AGENTS.md](conventions/agents-md/) | `AGENTS.md` | 大多数编码代理 - OpenAI Codex、Cursor、Jules、Aider、Gemini CLI、Zed 等 | [规范 ↗](https://agents.md) | | 🟢 | [CLAUDE.md](conventions/claude-md/) | `CLAUDE.md` | Claude 代码和读取 Claude 内存约定的工具 | [规范 ↗](https://code.claude.com/docs/en/memory) | | 🟢 | [特定工具指令文件](conventions/tool-specific-instructions/) | `GEMINI.md` `AGENT.md` `QWEN.md` `WARP.md` `CONVENTIONS.md` `copilot-instructions.md` | 每个文件由其同名工具读取 - Gemini CLI、Amp、Qwen Code、Warp、Aider、GitHub Copilot - 通常与 AGENTS.md 一起或作为桥梁 | [规范 ↗](https://agents.md) | - **[AGENTS.md](conventions/agents-md/)** - 一个普通的 Markdown “代理 README” - 构建/测试命令、约定和注意事项，代理在接触代码前需要了解。 最广泛采用的跨工具指令文件。 - **[CLAUDE.md](conventions/claude-md/)** - Anthropic 的 Claude 代码内存文件 - 在会话开始时自动加载，以在多个回合中传递项目命令、样式规则和长期指令。 - **[特定工具指令文件](conventions/tool-specific-instructions/)** - 特定于工具的指令文件，它们早于或与 AGENTS.md 共存。 一些工具现在默认为 AGENTS.md，同时保留遗留文件名。 ## 内存与状态 独立页面：[categories/memory-state.md](categories/memory-state.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [MEMORY.md](conventions/memory-md/) | `MEMORY.md` | Claude 代码的自动内存 - 每个项目索引，写入和重新读取每个会话 | [规范 ↗](https://code.claude.com/docs/en/memory) | | 🟢 | [内存库](conventions/memory-bank/) | `projectbrief.md` `productContext.md` `activeContext.md` `systemPatterns.md` `techContext.md` `progress.md` | Cline、Roo Code 和 Cursor（通过内存库自定义指令模式） | [规范 ↗](https://docs.cline.bot/best-practices/memory-bank) | - **[MEMORY.md](conventions/memory-md/)** - 持久的、代理维护的持久事实索引 - 在会话中写入和重新读取，以便代理累积项目内存而不是每次重新学习。 - **[内存库](conventions/memory-bank/)** - Cline 的结构化内存系统 - 一组 Markdown 文件，代理在每个任务开始时读取，以在会话内存重置后重建完整的项目上下文。 所示的六个文件是 Cline 的集合；像 Roo Code 这样的工具使用重叠但不同的变体。 ## 规范驱动开发 独立页面：[categories/spec-driven-development.md](categories/spec-driven-development.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [规范套件](conventions/spec-kit/) | `constitution.md` `spec.md` `plan.md` `tasks.md` | GitHub 规范套件的斜杠命令代理（Copilot、Claude、Gemini、Cursor 等） | [规范 ↗](https://github.com/github/spec-kit) | | 🟢 | [Kiro 控制文件](conventions/kiro-steering/) | `product.md` `structure.md` `tech.md` | AWS Kiro（控制文件主要是 Kiro 特有的） | [规范 ↗](https://kiro.dev/docs/steering) | - **[规范套件](conventions/spec-kit/)** - GitHub 的规范驱动工作流程 - 宪法加上每个功能的规范 → 计划 → 任务文件，驱动代理进行结构化、可审查的实现。 - **[Kiro 控制文件](conventions/kiro-steering/)** - Kiro 的持续控制文档 - 产品、结构和技术文件，为代理提供持久的项目上下文，不依赖于任何单个规范。 ## 技能与提示资产 独立页面：[categories/skills-prompt-assets.md](categories/skills-prompt-assets.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [SKILL.md](conventions/skill-md/) | `SKILL.md` | Claude 代理技能、Claude 代码、Amp、与代理技能兼容的工具 | [规范 ↗](https://agentskills.io/specification) | | 🟢 | [提示资产文件](conventions/prompt-assets/) | `.prompty` `.prompt` `system_prompt.txt` | Prompty 工具、Azure AI / 语义内核和加载外部提示的应用程序 | [规范 ↗](https://prompty.ai) | | 🟢 | [Claude 代码命令](conventions/claude-commands/) | `.md` | Claude 代码 - 项目 `.claude/commands/` 和用户 `~/.claude/commands/` | [规范 ↗](https://code.claude.com/docs/en/slash-commands) | | 🟢 | [Copilot 提示与指令文件](conventions/copilot-prompt-files/) | `.prompt.md` `.instructions.md` | VS Code / Copilot CLI 中的 GitHub Copilot | [规范 ↗](https://code.visualstudio.com/docs/agent-customization/prompt-files) | - **[SKILL.md](conventions/skill-md/)** - 一个自包含的、模型调用的能力文件，告诉代理何时加载可重用过程以及如何执行。 - **[提示资产文件](conventions/prompt-assets/)** - 外部提示文件 - Prompty 的 YAML 前置事项 `.prompty`、普通 `.prompt` 模板和 `system_prompt.txt` - 将提示从源代码中分离出来，以便可以单独版本化和编辑。 只有 `.prompty` 有正式的规范（prompty.ai）；`.prompt` 和 `system_prompt.txt` 是临时外部提示文件名。 - **[Claude 代码命令](conventions/claude-commands/)** - 一个 Markdown 文件，Claude 代码将其公开为 / 斜杠命令 - 一个可重用的、版本控制的提示工作流程，具有可选的前置事项（允许的工具、模型、参数提示）和 `$ARGUMENTS` 和 shell 占位符（@file 引用是 Claude 代码的一般功能，不是特定于命令）。 现在与代理技能收敛，但仍以其自身权利广泛提交。 - **[Copilot 提示与指令文件](conventions/copilot-prompt-files/)** - 模块化、路径范围的 Copilot 上下文：*.instructions.md 自动附加到匹配的文件，通过 applyTo glob 匹配，而 *.prompt.md 是可重用的提示，您可以通过名称调用 - 一个精细的表亲 `.github/copilot-instructions.md`。 ## 工具与连接 独立页面：[categories/tooling-connections.md](categories/tooling-connections.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [MCP 服务器配置](conventions/mcp-config/) | `.mcp.json` | Claude 代码、Cursor、VS Code / Copilot 和 Claude 桌面版 - 每个 MCP 主机都读取相同的 mcpServers 模式，尽管文件名和路径因工具而异 | [规范 ↗](https://code.claude.com/docs/en/mcp) | - **[MCP 服务器配置](conventions/mcp-config/)** - 一个 JSON 文件，告诉代理启动哪些模型上下文协议服务器以及如何启动（命令、参数、环境）- 使项目的工具和数据集成在所有支持 MCP 的客户端上可移植、可共享和可版本控制。 ## 规则与忽略文件 独立页面：[categories/rules-ignore-files.md](categories/rules-ignore-files.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [规则文件](conventions/agent-rules/) | `.cursorrules` `.mdc` `.clinerules` `.clinerules/` _(模式)_ `.windsurfrules` | Cursor（.cursorrules / .mdc）、Cline（.clinerules/ 和旧版 .clinerules）、Windsurf（.windsurfrules） | [规范 ↗](https://docs.cline.bot/customization/cline-rules) | | 🟢 | [AI 忽略文件](conventions/ai-ignore-files/) | `.aiignore` `.cursorignore` `.codeiumignore` | JetBrains Junie（.aiignore）、Cursor（.cursorignore）、Codeium/Windsurf（.codeiumignore） | [规范 ↗](https://cursor.com/docs/reference/ignore-file) | - **[规则文件](conventions/agent-rules/)** - 特定于工具的规则文件，用于控制代理行为 - 较旧的单一文件格式（.cursorrules、.clinerules、.windsurfrules）和较新的基于目录、通配符作用域的格式（.cursor/rules/*.mdc、.clinerules/、.windsurf/rules/*.md）。 - **[AI 忽略文件](conventions/ai-ignore-files/)** - 语法类似 gitignore 的文件，用于隔离 AI 代理与路径 - 秘密、供应商代码、生成输出 - 以便它们永远不会被发送到模型作为上下文。 ## 设计 独立页面：[categories/design.md](categories/design.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [DESIGN.md](conventions/design-md/) | `DESIGN.md` | Google Stitch 原生；以及编码代理（例如 Claude 代码）当指向它作为设计上下文时 | [规范 ↗](https://github.com/google-labs/design.md) | - **[DESIGN.md](conventions/design-md/)** - 一个结构化、可机器读取的设计规范 - 标记、组件和布局意图 - 代理读取以生成或保持 UI 与已建立系统的一致性。 2026 年由 Google Labs 以跨工具草案规范的形式开源。 ## 网页与可发现性 独立页面：[categories/web-discoverability.md](categories/web-discoverability.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟢 | [llms.txt](conventions/llms-txt/) | `llms.txt` `llms-full.txt` _(模式)_ | 文档站点为 LLM 工具和爬虫发布它 - 虽然没有主要提供商确认读取它 | [规范 ↗](https://llmstxt.org) | | 🟢 | [pricing.md](conventions/pricing-md/) | `pricing.md` | 代理和 LLM 浏览器获取干净的、可解析的定价页面 | [规范 ↗](https://resend.com/pricing.md) | - **[llms.txt](conventions/llms-txt/)** - 一个提议的、广泛发布的标准：一个根级 Markdown 文件，为 LLMs 提供站点的精选、丰富的链接地图。 跨数百个开发者文档站点发布 - 但主要 LLM 提供商是否实际读取它仍未得到证明。 - **[pricing.md](conventions/pricing-md/)** - 定价页面的 Markdown 双胞胎 - 相同的 URL 带有 .md 后缀 - 以便代理获取结构化的计划和数字，而不是刮擦营销 HTML。 一个具体的、已实施的 page.md 模式实例。 ## 代理-网页信任 独立页面：[categories/agent-web-trust.md](categories/agent-web-trust.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟠 | [auth.md](conventions/auth-md/) | `auth.md` | 发现如何对服务进行身份验证的代理（早期采用者） | [规范 ↗](https://workos.com/auth-md) | | 🔵 | [ai.txt](conventions/ai-txt/) | `ai.txt` | 自愿遵守 AI 使用偏好的 AI 训练/数据挖掘爬虫；爬虫支持尚不可靠 | [规范 ↗](https://datatracker.ietf.org/doc/draft-car-ai-txt-wellknown/) | - **[auth.md](conventions/auth-md/)** - 一个 Markdown 文件，告诉代理如何与服务进行身份验证 - 身份验证端点和流程的发现。 WorkOS 作为一个真正的、有效的约定推出，但在此之外的采用仍处于早期阶段。 - **[ai.txt](conventions/ai-txt/)** - 一个声明机器可读的同意、许可或 AI 训练和数据挖掘策略的文本文件。 Spawning 推广了部署的根文件模式，2026 年的互联网草案现在提出了众所周知的 URI；采用和爬虫服从仍然很薄。 ## 身份与协议 独立页面：[categories/identity-protocols.md](categories/identity-protocols.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🟠 | [代理卡（A2A）](conventions/agent-cards/) | `agent-card.json` `agent.json` _(模式)_ | A2A 兼容代理发现另一个代理的能力 | [规范 ↗](https://a2a-protocol.org/latest/specification/) | - **[代理卡（A2A）](conventions/agent-cards/)** - 代理到代理（A2A）能力卡 - 一个 JSON 文档，通过众所周知的路径宣传代理的技能、端点和身份验证，以便其他代理可以发现和调用它。 现为 Linux 基金会项目，v1.0；采用正在增长但仍处于早期阶段。 ## 提议的命名空间 独立页面：[categories/proposed-namespace.md](categories/proposed-namespace.md) | | 约定 | 文件 | 读取者 | 规范 | | --- | --- | --- | --- | --- | | 🔵 | [protocols.md 命名空间](conventions/protocols-md/) | `proof.md` | - （无演示读取者；愿景性） | [规范 ↗](https://protocols.md) | - **[protocols.md 命名空间](conventions/protocols-md/)** - 单个维护者的预注册命名空间，包含约 74 个有抱负的 .md “协议”（proof.md、signature.md、reputation.md、…），作为未来代理 Web 的谢林点。 已发布概念，无演示采用 - 请参阅页面以获取审计的、诚实的警告。 ## 维护示例 示例文件被获取，而不是发明的。 提取器从公共源拉取它们，将它们存储在 `conventions/<slug>/examples/<source>/<filename>` 下，并添加一行出处注释。 示例文件仍在其上游所有者的许可和条款下；请参阅 [THIRD_PARTY_EXAMPLES.md](THIRD_PARTY_EXAMPLES.md) 在重用它们之前。 要刷新所有内容： ```bash pip install -r scripts/requirements.txt python scripts/extract.py # 获取真实文件 + 重建每个约定的 README python scripts/build_readme.py # 从 scripts/targets.json 重建此 README ``` 重新运行是幂等的。 缺少的目标打印一个 `miss` 并被跳过。 示例文件是代表性的样本：任何超过 256 KB 的文件（例如，多 MB 的 `llms-full.txt`）都会被截断，并附有指向完整源的标记。 `scripts/targets.json` 仍然是尚未迁移的约定的真实来源；`skill-md` 试点使用本地约定元数据。 编辑相关源并重新运行两个脚本。 Makefile 中提供了快捷目标： ```bash make verify # 模式 + 生成的文件 + 示例出处 + 链接 make extract # 获取公共示例并重建生成的文档 make license-report # 总结外部示例的许可 ``` CI 保持生成的文件和链接诚实。 [验证工作流](.github/workflows/verify.yml) 检查生成的文档是否与目录元数据和迁移的本地元数据匹配，并且每个拉取请求和每周每个规范、示例和实例 URL 仍然解析。 在本地运行相同的链接检查，使用 `python scripts/check_links.py`。 ## 贡献 阅读 [CONTRIBUTING.md](CONTRIBUTING.md)。 简而言之：条目必须通过上述过滤器，并带有其成熟度等级的证据。 将源添加到 `scripts/targets.json` 以获取非迁移的约定，运行脚本并打开拉取请求。 `skill-md` 试点使用本地约定元数据。 不要手动编写示例文件。 在提出相邻标准之前，请查看 [WATCHLIST.md](WATCHLIST.md)。 项目方向位于 [ROADMAP.md](ROADMAP.md)。 ## 许可证 本存储库中的策划、脚本和原始文本均在 [MIT](LICENSE) 下。 供应商的示例文件仍在其上游所有者的许可和条款下；请参阅 [THIRD_PARTY_EXAMPLES.md](THIRD_PARTY_EXAMPLES.md)。