agents-md-generator

AGENTS.md 生成器是一款專為 AI 輔助開發設計的關鍵工程工具，旨在為程式碼庫知識建立結構。透過創建輕量級的分層文檔系統，它確保編碼代理在不會耗盡 token 視窗的情況下獲得最相關的上下文。此工具針對需要建立 AI 友好專案文檔的技術負責人與開發人員，遵循「最近優先」層級原則，確保代理始終能夠存取最相關的專案規範、設計模式與即時索引指令。

• 自動分析程式碼庫結構，識別 Monorepo 工作區、技術堆疊與關鍵目錄。

• 生成根目錄 AGENTS.md 檔案，重點包含通用規範、安全性協定與高階專案快照。

• 產出針對子目錄的 AGENTS.md 檔案，包含細粒度的模式、命名慣例與「執行/避免」(DO/DON'T) 程式碼範例。

• 實作即時索引功能，利用 ripgrep 與 find 等指令工具引導代理查找程式碼，無需嵌入完整原始碼檔案。

• 支援設計系統、後端 API 服務、資料庫層與測試套件的專門模板。

• 輸入：使用者的觸發詞，如「create AGENTS.md」、「generate agents」或「AI documentation setup」。

• 輸出：包含摘要分析、輕量級根目錄配置以及詳細模組級別文檔的結構化 Markdown 層級。

• 最佳實踐：將根目錄檔案保持在 200 行以內以維護 token 效率。務必將子檔案連結至根目錄，並使用絕對路徑範例說明程式碼模式。

• 限制：此工具針對結構化專案樹（如 Turborepo, pnpm workspaces）進行了優化。請確保「Pre-PR」指令區塊保持為可單擊複製的 Shell 指令，以實現最高操作速度。

• 適用場景：為現有倉庫導入新的 AI 編碼代理、在團隊環境中強制執行嚴格的架構模式，並透過提供紮實的指令式文檔來減少幻覺。