mcpField
C
create-agents-md

create-agents-md

github.com/siviter-xyzAgent 工作流22303 次安装32 周前更新
代码仓库

关于 create-agents-md

指导如何在 AGENTS.md 中编写项目专属说明的技能，涵盖根目录与嵌套文件的放置方式、内容组织，以及何时应改用其他形式。

主要功能

  1. 01根目录与文件夹级说明文件
  2. 02单体仓库的包级指导
  3. 03AGENTS.md 的结构与位置
  4. 04精简聚焦的编写实践
  5. 05说明不适用 AGENTS.md 的情形

适用场景

  1. 01记录供 Agent 遵循的项目规范
  2. 02为特定目录添加规则
  3. 03在单体仓库记录包级说明
  4. 04精简项目指令内容

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/siviter-xyz/dot-agent --skill create-agents-md

安装后在 Claude Code 中输入/create-agents-md确认已加载。

附带文件references/best-practices.md

详细介绍

创建 AGENTS.md

用于创建 AGENTS.md 文件的指南，帮助编写项目专属的内联规则。

何时使用 AGENTS.md

  • 需要提交到仓库的小型项目专属说明
  • 针对特定目录的规则
  • 单体仓库中的软件包专属说明
  • 测试目录中的测试专属指南

何时不使用 AGENTS.md

  • 可在多个项目间复用的知识 → 使用技能
  • 大型文档 → 使用带参考资料的技能
  • 复杂工作流 → 使用带脚本的技能

AGENTS.md 结构

AGENTS.md 是一个不含元数据的简单 Markdown 文件：

# Project Instructions

## Code Style

- Use TypeScript for all new files
- Prefer functional components in React
- Use snake_case for database columns

## Architecture

- Follow the repository pattern
- Keep business logic in service layers

位置

  • 项目根目录：AGENTS.md – 面向整个项目的主要内联说明和参考资料（命令、技术栈、测试、代码风格、架构、安全边界）。
  • 子目录：subdirectory/AGENTS.md – 当本地行为与根目录存在明显差异时，提供目录或软件包专属说明（例如特定软件包、服务或测试目录）。
  • 嵌套支持：Agent 通常会结合最近的 AGENTS.md 与父级文件中的说明；根目录文件应保持通用，仅在确实需要更具体规则时使用嵌套的 AGENTS.md。

最佳实践

  • 保持 AGENTS.md 文件简短、聚焦
  • 用于说明项目专属约定
  • 优先使用简短、具体的参考资料，而非冗长的文字说明：
    • 链接到项目文档、规范和运维手册
    • 指向示例文件或目录（例如，see src/api/users.ts for canonical pattern）
    • 列出最重要的命令，并提供准确的 CLI 调用方式
  • 尽可能引用现有代码示例
  • 随项目演进及时更新

参考资料

如需详细的最佳实践，请参阅 references/best-practices.md。

评论

支持 Markdown