create-agentsmd

用途

create-agentsmd 是一个提示词类技能，用于引导 AI 编码智能体在仓库根目录创建一份完整、准确的 AGENTS.md 文件。AGENTS.md 是一种开放格式，旨在为编码智能体提供其在项目上有效工作所需的上下文和指令，可视为“给智能体看的 README”，与面向人类的 README.md 形成互补。

主要能力

该提示词要求生成的 AGENTS.md 遵循 https://agents.md/ 的公开指引，并体现以下关键原则：

面向智能体：包含面向自动化工具的详细技术指令。
与 README.md 互补：不替代人类文档，而是补充智能体特有的上下文。
标准化位置：放在仓库根目录（Monorepo 中可放在各子项目根目录）。
开放格式：使用标准 Markdown，结构灵活。
生态兼容：可与 20 多种 AI 编码工具配合使用，包括 Cursor、Aider、Gemini CLI 等。

文件结构与使用方式

提示词要求将该文件创建为仓库根目录下的 AGENTS.md，使用标准 Markdown 格式，无必填字段，结构可根据项目需要灵活调整。建议包含的必需部分有：

项目概览：项目简介、复杂项目的架构概述、所用关键技术与框架。
安装命令：安装说明、环境搭建步骤、依赖管理命令、数据库设置（如适用）。
开发工作流：如何启动开发服务器、构建命令、监听/热重载设置、包管理器细节（npm、pnpm、yarn 等）。
测试说明：如何运行单元、集成、端到端测试，测试文件位置与命名约定，覆盖率要求，所用测试框架与模式，以及如何运行子集测试。
代码风格准则：语言约定、Lint 与格式化规则、文件组织模式、命名约定、导入导出模式。
构建与部署：构建命令与输出、环境配置、部署步骤与要求、CI/CD 流水线信息。

可选但推荐的部分包括：安全注意事项（安全测试要求、密钥管理、认证模式、权限模型）、Monorepo 说明（多包协作方式、跨包依赖、选择性构建与测试、按包命令）、Pull Request 规范（标题格式、提交前必需检查、评审流程、提交信息约定）、调试与故障排查（常见问题与解决方案、日志模式、调试配置、性能注意事项）。

提示词还提供了可自定义的示例模板，以及 agents.md 网站上的真实示例，示例中使用了 pnpm dlx turbo run where <project_name>、pnpm install --filter <project_name>、pnpm create vite@latest <project_name> -- --template react-ts、pnpm turbo run test --filter <project_name>、pnpm vitest run -t "<test name>"、pnpm lint --filter <project_name> 等具体命令，并给出 PR 标题格式 [<project_name>] <Title>。

实施步骤

提示词要求执行以下步骤：

分析项目结构，理解所用语言与框架、包管理器与构建工具、测试框架、项目架构（Monorepo、单包等）。
通过检查 package.json 脚本、Makefile 或其他构建文件、CI/CD 配置文件、文档文件来识别关键工作流。
编写涵盖所有必需安装与开发命令、测试策略与命令、代码风格与约定、构建与部署流程的内容。
包含智能体可直接执行的具体、可操作命令，并验证所有命令与文档一致可用。
聚焦智能体需要了解的信息，而非通用项目信息。

最佳实践

具体明确：给出精确命令，而非模糊描述。
使用代码块：用反引号包裹命令，保证清晰。
包含上下文：解释某些步骤为何必要。
保持最新：随项目演进更新文档。
测试命令：确保列出的命令确实可用。
考虑嵌套文件：Monorepo 中可按需在子项目创建 AGENTS.md。

对于大型 Monorepo，应在仓库根目录放置主 AGENTS.md，在子项目目录创建额外的 AGENTS.md，位置最近的 AGENTS.md 优先，并包含包/项目间的导航提示。

适用场景与限制

该技能适用于需要为仓库生成规范化智能体说明文件的开发者与团队，尤其是在使用多种 AI 编码工具协作时。格式本身刻意保持灵活，需根据项目实际调整。它属于“活的文档”，应随项目演进持续更新。关于该技能的收费、价格、平台支持范围等具体信息，资料暂未提供；如需使用，应以其来源仓库和 agents.md 公开规范为准。