用途:为代码仓库生成一份 AGENTS.md,向 AI 智能体说明项目结构、构建命令、测试方式与代码约定。当用户要求生成此类文件时使用。
主要能力:生成约 20 行的 AGENTS.md,内容包含构建/检查/测试命令(尤其是如何运行单个测试)、架构概览(重要子项目、内部 API、数据库)、代码风格指南(导入、约定、格式化、类型、命名、错误处理)。
使用方式:先检查是否已存在 AGENTS.md 或 AGENT.md,若存在则更新而非覆盖;再检查并整合已有规则文件,包括 .cursor/rules/ 或 .cursorrules、CLAUDE.md、.windsurfrules、.clinerules、.goosehints、.github/copilot-instructions.md;随后分析代码库结构,查看 package.json、Cargo.toml、pyproject.toml 等,识别测试框架与命令,查找 lint/format 配置文件,梳理目录结构;最后写出简洁的 AGENTS.md,保存到仓库根目录。
示例结构:包含 Commands(如 Build: npm run build、Test: npm test(单个测试:npm test -- file.test.ts)、Lint: npm run lint)、Architecture(如 /packages/ 下的 monorepo、/packages/api/ 主 API、PostgreSQL 配 Prisma)、Style(如 TypeScript 严格模式、ESLint + Prettier、优先命名导出、使用 @/utils 的 logger 而非 console)。
适用场景:需要让 AI 编码智能体快速了解仓库约定与命令的项目。
限制:资料未提供具体安装命令、收费、价格、平台或效果信息。