agents-md-generator
分析存储库结构并生成或更新标准化 AGENTS.md 文件,作为 AI 代理的贡献者指南。支持单一存储库和单一存储库结构。测量 LOC 以确定字符限制并生成涵盖概述、文件夹结构、模式、约定和工作协议的结构化文档。更新模式仅刷新标准部分,同时保留用户定义的自定义部分。在设置新存储库、将 AI 代理加入现有代码库、更新现有 AGENTS.md 或用户提及 AGENTS.md 时使用。
分析存储库结构并生成或更新标准化 AGENTS.md 文件,作为 AI 代理的贡献者指南。支持单一存储库和单一存储库结构。测量 LOC 以确定字符限制并生成涵盖概述、文件夹结构、模式、约定和工作协议的结构化文档。更新模式仅刷新标准部分,同时保留用户定义的自定义部分。在设置新存储库、将 AI 代理加入现有代码库、更新现有 AGENTS.md 或用户提及 AGENTS.md 时使用。
以最大令牌效率创建、优化、更新和验证 AGENTS.md 文件。当用户要求 (1) 为任何存储库创建新的 AGENTS.md 文件,(2) 优化/压缩现有 AGENTS.md 以减少令牌数量,(3) 更新/刷新 AGENTS.md 以与代码库更改同步,(4) 验证 AGENTS.md 质量和完整性,或 (5) 改进 AGENTS.md 文件以使 AI 代理更有效时使用。始终生成令牌高效、精简的输出,重点关注可操作的命令和模式,同时保持与模型无关的语言。
使用此技能来处理任何创建、更新、审查或改进指导 AI 编码工具的文件的请求,例如 AGENTS.md、Copilot 上下文文件或代理指令。当用户想要帮助 AI 生成符合项目约定、避免常见错误或理解非显而易见规则的代码时触发 - 无论是针对整个存储库、子目录还是特定组件。还可用于有关设置 Copilot 或 Cursor 上下文、将 AI 添加到团队实践或保持代理指南最新的查询 - 即使未提及 AGENTS.md 的名称。 --- # AGENTS.md 技能 `AGENTS.md` 是 AI 编码代理的自述文件 — 它为 GitHub Copilot、Cursor 和 Claude Code 等工具提供了生成适合您项目的代码所需的上下文,而无需不断地来回修正。 ## 黄金法则:只包含不明显的事情 这是最重要的原则。 在添加任何行之前,询问:**“代理可以通过阅读代码或配置文件来解决这个问题吗?”** 如果是 - 跳过它。代理可以读取“package.json”、“pyproject.toml”、“*.csproj”、目录结构、导入和现有代码。 AGENTS.md 适用于那些*不*可见的内容: - 任何 linter 或分析器都没有强制执行的特定于项目的约定 - “永远不要做 X”模式,*看起来*合理,但在此代码库中是错误的 - 非标准或需要特定于项目的标志的命令 - 需要解释的领域术语或架构选择 - 代理在这里实际犯的常见错误(从经验中发现) - 绝不能违反的安全约束和规则 **冗余内容会主动降低质量** ——它浪费了代理的上下文窗口,并用已有的噪声稀释了真实信号。 ## AGENTS.md 的两种形状 ### 根级 `AGENTS.md` (存储库根)
使用主机事实和系统工具详细信息生成特定于计算机的 AGENTS.local.md
通过A/B测试评估和优化AGENTS.md/CLAUDE.md指令文件。当用户说“评估我的agents.md”,“测试我的claude.md”,“优化我的指令”,“哪些规则很重要”,“修剪我的代理文件”,或者想知道全局配置中的哪些指令实际上改变了模型行为而不是自重时使用。
skill-sample/ ├─ SKILL.md ⭐ 必备:技能说明入口:用途 / 安装 / 用法 / 示例 / 依赖 ├─ manifest.sample.json ⭐ 推荐:机器可读元信息:用于索引 / 校验 / 自动填表 ├─ LICENSE.sample ⭐ 推荐:授权与使用范围:开源 / 限制 / 商用说明 ├─ scripts/ │ └─ example-run.py ✅ 可运行示例脚本:让用户导入后立刻验证“能用” ├─ assets/ │ ├─ example-formatting-guide.md 🧩 输出规范:统一排版 / 结构 / 风格 │ └─ example-template.tex 🧩 模板资源:报告/文档模板,快速生成标准产物 └─ references/ 🧩 参考资料库:方法论 / 结构指南 / 最佳实践 ├─ example-ref-structure.md 🧩 结构参考:章节框架 / 目录组织 ├─ example-ref-analysis.md 🧩 分析参考:常用套路 / 指标口径 └─ example-ref-visuals.md 🧩 视觉参考:图表规范 / 可视化建议
更多 Agent Skills 规范 详见Anthropic官方文档:https://agentskills.io/home
├─ ⭐ 必备:YAML Frontmatter(必须存在,放在文件最顶部) │ ├─ ⭐ name :技能唯一名;须符合命名规则,并建议与目录名一致 │ └─ ⭐ description :技能描述;建议包含触发关键词(便于检索/匹配) │ ├─ ✅ 可选:Frontmatter 扩展字段(规范允许,但非强制) │ ├─ ✅ license :许可证标识(也可配合单独 LICENSE 文件) │ ├─ ✅ compatibility :兼容性/运行环境要求(仅在确实有限制时写) │ ├─ ✅ metadata :任意键值对(如 author/version/source_url 等) │ └─ 🧩 allowed-tools :允许工具白名单(规范标注为 experimental) │ └─ ✅ 推荐:Markdown 正文(自由格式,但建议按“渐进式披露”组织) ├─ ✅ Overview / Purpose :一句话说明目标 + 不做什么(边界) ├─ ✅ When to use :触发条件/适用场景(让模型/用户知道何时调用) ├─ ✅ Step-by-step :步骤化流程(最好 3–6 步,保证可复现) ├─ ✅ Inputs / Outputs :输入格式、输出格式、产物位置(文件/文本/JSON等) ├─ ✅ Examples :至少 1 个可复制示例(越“能跑”越好) ├─ 🧩 Files & References :引用assets/、references/、scripts/(相对路径) ├─ 🧩 Edge cases :边界情况/限制(大文件、速率限制、失败回退) ├─ 🧩 Troubleshooting :常见错误与解决(依赖缺失、路径不对、权限问题) └─ 🧩 Safety notes :涉及联网/写文件/执行命令时给出提醒(建议写)
在 GitHub 和各类社区里,技能文件分散、难检索、也难判断是否可靠。SkillWink 把开源技能集中整理成可搜索、可筛选、可直接下载使用的技能库,让你更快找到“正好能用”的那一个。并且支持在SkillWink上直接上传skills。
我们提供 AI 语义搜索 + 关键字检索,支持 版本更新与多维排序(下载/点赞/评论/更新),并为每个技能提供 SKILL.md 开放标准与来源信息。你还可以在详情页直接 评论讨论、交流用法与改进建议。
快速上手:
支持下载与导入 skills(.zip/.skill),本地放置后即可生效:
~/.claude/skills/(Claude Code)
~/.codex/skills/(Codex CLI)
~/.gemini/skills/(Gemini CLI)
同一份 SKILL.md 跨平台通用。
你需要了解的:技能是什么、怎么运行的、怎么找、怎么导入、怎么判断可信、怎么参与共建。
这里的“skills(技能)”是一种可复用的任务能力包,通常包含 SKILL.md 说明(用途、输入输出、使用方法)以及可选的脚本/模板/示例文件。
你可以把它理解为:给 AI 助手或工具链用的“插件说明书 + 资源包”,可被反复安装与分享。
技能系统采用“渐进式披露”策略,高效管理上下文信息,具体流程如下:
发现阶段:系统启动时,智能体仅加载各技能的名称与简要描述——信息精简,足以判断其适用场景,避免冗余加载。
激活阶段:当任务需求与某技能描述匹配时,智能体才将对应的完整 SKILL.md 说明文档动态载入上下文。
执行阶段:智能体严格遵循文档指引执行操作,并按需调用关联文件或运行内置代码模块。
核心优势:该设计使智能体始终保持轻量高效,同时具备“按需扩展上下文”的能力,既保障响应速度,又确保复杂任务拥有充分执行依据。
推荐 3 种方式组合使用:
注:以上导入方式文件大小控制在10M之内。
常见路径如下(不同系统略有差异,以你本机为准):
同一份 SKILL.md 通常可以跨工具复用。你在 SkillWink 导入后,也可以查看“放置指引/安装说明”。
可以。很多技能本质是标准化说明 + 资源,只要目标工具支持读取该格式,就能共享使用。
比如:检索类技能 + 写作类技能 + 自动化脚本,形成“发现 → 处理 → 输出”的工作流。
一部分skills来源于公开的 GitHub 仓库。我们会筛掉低质量仓库(至少 2 星),并扫描基本质量指标,还有一部分是SkillWink平台的创作者独立上传的。作为使用者,在安装前应始终审查代码,对安全问题负责。
最常见原因是这几类:
我们会尽量避免。你可以用 排序 + 评论 让“好用的”更靠前: