---

name: agents-md description: 当用户要求"创建 AGENTS.md"、"更新 AGENTS.md"、"维护代理文档"、"设置 CLAUDE.md"或需要保持代理指令简洁时使用此技能。强制执行基于研究的最小化、高信号代理文档最佳实践。 risk: unknown source: community

维护 AGENTS.md

AGENTS.md 是面向代理的规范文档。保持最小化——代理很有能力，不需要手把手指导。目标 60 行以内；永远不超过 100 行。文档长度增加时，指令遵循质量会下降。

何时使用

• 用户要求创建、更新或审计 AGENTS.md 或 CLAUDE.md。
• 项目需要从实际工具链和仓库布局中提取的简洁、高信号代理指令。
• 现有代理文档太长、重复或偏离了真实项目约定。

文件设置

1. 在项目根目录创建 AGENTS.md
2. 创建符号链接：ln -s AGENTS.md CLAUDE.md

编写前

分析项目以了解文件中应包含什么：

1. 包管理器 — 检查锁文件（pnpm-lock.yaml、yarn.lock、package-lock.json、uv.lock、poetry.lock）
2. Linter/格式化配置 — 查找 .eslintrc、biome.json、ruff.toml、.prettierrc 等（不要在 AGENTS.md 中重复这些）
3. CI/构建命令 — 检查 Makefile、package.json 脚本、CI 配置中的规范命令
4. Monorepo 指标 — 检查 pnpm-workspace.yaml、nx.json、Cargo workspace 或子目录 package.json 文件
5. 现有约定 — 检查现有的 CONTRIBUTING.md、docs/ 或 README 模式

编写规则

• 标题 + 要点 — 不写段落
• 代码块 — 用于命令和模板
• 引用，不嵌入 — 指向现有文档："参见 CONTRIBUTING.md 了解设置"或"遵循 src/api/routes/ 中的模式"
• 无填充 — 无介绍、结论或客套话
• 信任能力 — 省略显而易见的上下文
• 优先文件级命令 — 单文件测试/lint/类型检查命令优于项目级构建
• 不重复 linter — 代码风格在 linter 配置中，不在 AGENTS.md 中

必需章节

包管理器

仅列出工具和关键命令：

## Package Manager
Use **pnpm**: `pnpm install`, `pnpm dev`, `pnpm test`

文件级命令

文件级命令比完整项目构建更快更省。可用时始终包含：

## File-Scoped Commands
| Task | Command |
|------|---------|
| Typecheck | `pnpm tsc --noEmit path/to/file.ts` |
| Lint | `pnpm eslint path/to/file.ts` |
| Test | `pnpm jest path/to/file.test.ts` |

提交归属

始终包含此章节。代理应使用自己的身份：

## Commit Attribution
AI commits MUST include:
Co-Authored-By: (the agent model's name and attribution byline)
Example: Co-Authored-By: Claude Sonnet 4 <noreply@example.com>

关键约定

代理必须遵循的项目特定模式。保持简短。

可选章节

仅在真正需要时添加：

• API 路由模式（展示模板，不解释）
• CLI 命令（表格格式）
• 文件命名约定
• 项目结构提示（指向关键文件，标记要避免的遗留代码）
• Monorepo 覆盖（子目录 AGENTS.md 文件覆盖根目录）

反模式

省略这些：

• "欢迎来到..."或"本文档解释..."
• "你应该..."或"记得..."
• 已在配置文件中的 linter/格式化规则（.eslintrc、biome.json、ruff.toml）
• 列出已安装的技能或插件（代理会自动发现）
• 存在文件级替代方案时的完整项目构建命令
• 显而易见的指令（"运行测试"、"写干净的代码"）
• 解释为什么（只说是什么）
• 长篇散文段落

示例结构

# Agent Instructions

## Package Manager
Use **pnpm**: `pnpm install`, `pnpm dev`

## Commit Attribution
AI commits MUST include:
Co-Authored-By: (the agent model's name and attribution byline)

## File-Scoped Commands
| Task | Command |
|------|---------|
| Typecheck | `pnpm tsc --noEmit path/to/file.ts` |
| Lint | `pnpm eslint path/to/file.ts` |
| Test | `pnpm jest path/to/file.test.ts` |

## API Routes
[Template code block]

## CLI
| Command | Description |
|---------|-------------|
| `pnpm cli sync` | Sync data |

限制

• 仅在任务明确匹配上述范围时使用此技能。
• 不要将输出视为特定环境验证、测试或专家审查的替代品。
• 如果缺少所需输入、权限、安全边界或成功标准，请停下来要求澄清。