本文根據 getsentry/skills 倉庫裏該技能的 SKILL.md 與倉庫 README 整理,資料核對於 2026-10-11。所在倉庫 getsentry/skills 在 GitHub 約 1045 Star(同日數據)。技能內容會隨倉庫更新,以倉庫為準。
這個 Skill 做什麼
項目裏的 AGENTS.md(或 CLAUDE.md)是每次會話都會加載的說明,寫得越長,佔的上下文越多,模型反而越抓不住重點。agents-md 的立場很明確:短。description:創建並維護簡潔的 AGENTS.md 和 CLAUDE.md 項目說明文件;用於新建或更新 AGENTS.md、設定 CLAUDE.md、記錄倉庫的智能體約定,或讓編程智能體的說明保持最小、以引用為主。
SKILL.md 第一句就是目標:簡潔、可執行,力爭 60 行以內,絕不超過 100 行。
工作流四步:
- 先檢查再動筆:從鎖文件和清單文件確認包管理器;從
package.json、Makefile、任務運行器和 CI 配置裏找出真實命令;看 README、貢獻指南、docs/、安全策略等現有文檔;看當前的代碼模式、測試佈局、生成文件和不該碰的遺留區域。 - 選範圍:根目錄的文件寫全倉庫的預設規則;只有某個子目錄的命令或規則確實不同時才在那裏再放一份,離代碼最近的那份優先,而且要比根文件更短。
- 寫出最小夠用的文件。
- 核對寫進去的每個路徑和命令都真實存在。
文件設定上,在倉庫根目錄建 AGENTS.md;需要兼容 Claude 的入口時,把 CLAUDE.md 做成指向它的軟連結,不維護兩份內容不同的副本。寫作規則包括:用標題、列表和表格,不寫大段文字;路徑用倉庫相對路徑,不寫「見文檔」這種含糊的指向;已有的文檔和規範用引用,不要抄一遍;測試、檢查類命令優先給能針對單個文件運行的寫法。後面還有外部引用規則和一組反面例子。
怎麼安裝
agents-md 收在 Sentry 的 sentry-skills 插件裏。Claude Code 裏(命令來自倉庫 README):
bash
claude plugin marketplace add getsentry/skills
claude plugin install sentry-skills@sentry-skills
裝好後以 /sentry-skills:agents-md 的形式出現,也會按場景自動觸發。其他智能體用 npx skills add getsentry/skills,想只裝這一個就按 skills CLI 文檔加上 --skill agents-md。
倉庫整體介紹和其他安裝方式,詳見本站《getsentry/skills 是什麼、怎麼安裝:Sentry 工程團隊自用的 Agent Skills(代碼評審、提交規範、Django 審查)》。
怎麼用
- 「給這個倉庫寫一份 AGENTS.md」。
- 「現在的 CLAUDE.md 有三百多行,按 agents-md 的標準精簡,重複文檔的部分改成引用」。
- 「
packages/mobile的構建命令和別處不一樣,給它單獨加一份說明」。
適合誰 / 侷限
適合剛開始在團隊裏推廣編程智能體、需要一份像樣的項目說明的人,也適合清理越寫越長的舊文件。侷限:行數上限是 Sentry 團隊的取捨,規則確實多的項目需要把細節拆到被引用的文檔裏;Windows 上軟連結需要額外權限或設定,可以改用內容相同的文件並自行保持同步;它只能寫出倉庫裏看得出來的約定,口頭規矩要你補充。
注意事項
- 許可:Apache-2.0。
- 會新建或改寫倉庫根目錄的說明文件,改完看一遍差異再提交。
- 不帶腳本,目錄裏另有兩份說明其依據和規格的文檔。
0 條評論
還沒有評論,來搶沙發~