/ 目錄 / 演練場 / agent-rules-skill
● 社群 netresearch ⚡ 即開即用

agent-rules-skill

作者 netresearch · netresearch/agent-rules-skill

依循 agents.md 慣例產生 AGENTS.md 檔案,讓任何 AI 程式代理(Claude Code、Cursor、Codex)都能快速了解你的專案架構。

由 Netresearch 開發的小型專注型 Claude Code 技能。它會掃描程式碼庫並依循 agents.md 慣例起草一份 AGENTS.md 檔案——這是一個日益普及的標準,用於在單一檔案中告知 AI 代理專案慣例、建置指令、測試方式與貢獻規則。

為什麼要用

核心特性

即時演示

實際使用效果

agent-rules-skill.replay ▶ 就緒
0/0

安裝

選擇你的客戶端

~/Library/Application Support/Claude/claude_desktop_config.json  · Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "agent-rules-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/netresearch/agent-rules-skill",
        "~/.claude/skills/agent-rules-skill"
      ],
      "_inferred": true
    }
  }
}

開啟 Claude Desktop → Settings → Developer → Edit Config。儲存後重啟應用。

~/.cursor/mcp.json · .cursor/mcp.json
{
  "mcpServers": {
    "agent-rules-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/netresearch/agent-rules-skill",
        "~/.claude/skills/agent-rules-skill"
      ],
      "_inferred": true
    }
  }
}

Cursor 使用與 Claude Desktop 相同的 mcpServers 格式。專案級設定優先於全域。

VS Code → Cline → MCP Servers → Edit
{
  "mcpServers": {
    "agent-rules-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/netresearch/agent-rules-skill",
        "~/.claude/skills/agent-rules-skill"
      ],
      "_inferred": true
    }
  }
}

點擊 Cline 側欄中的 MCP Servers 圖示,然後選 "Edit Configuration"。

~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "agent-rules-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/netresearch/agent-rules-skill",
        "~/.claude/skills/agent-rules-skill"
      ],
      "_inferred": true
    }
  }
}

格式與 Claude Desktop 相同。重啟 Windsurf 生效。

~/.continue/config.json
{
  "mcpServers": [
    {
      "name": "agent-rules-skill",
      "command": "git",
      "args": [
        "clone",
        "https://github.com/netresearch/agent-rules-skill",
        "~/.claude/skills/agent-rules-skill"
      ]
    }
  ]
}

Continue 使用伺服器物件陣列,而非映射。

~/.config/zed/settings.json
{
  "context_servers": {
    "agent-rules-skill": {
      "command": {
        "path": "git",
        "args": [
          "clone",
          "https://github.com/netresearch/agent-rules-skill",
          "~/.claude/skills/agent-rules-skill"
        ]
      }
    }
  }
}

加入 context_servers。Zed 儲存後熱重載。

claude mcp add agent-rules-skill -- git clone https://github.com/netresearch/agent-rules-skill ~/.claude/skills/agent-rules-skill

一行命令搞定。用 claude mcp list 驗證,claude mcp remove 移除。

使用場景

實戰用法: agent-rules-skill

為尚未擁有 AGENTS.md 的專案產生一份

👤 正在將 AI 程式代理引入既有程式碼庫的團隊 ⏱ ~15 min beginner

何時使用: 團隊剛開始使用 Claude Code/Cursor,但還沒有人撰寫入門說明文件。

前置條件
  • 已安裝技能 — git clone https://github.com/netresearch/agent-rules-skill ~/.claude/skills/agent-rules-skill
步驟
  1. 在專案上執行
    Use agent-rules-skill. Analyze this repo and draft an AGENTS.md following the convention.✓ 已複製
    → 草稿包含建置/測試指令、lint 設定、程式風格說明與注意事項
  2. 細部調整
    Add a section on where not to edit (generated files, vendor/).✓ 已複製
    → 已新增含明確路徑的章節
  3. 提交
    Commit as docs/AGENTS.md.✓ 已複製
    → 檔案已提交至專案根目錄或 docs/ 目錄下

結果: 一份持續維護的 AGENTS.md,讓未來每次代理工作階段都能帶著完整背景脈絡開始。

注意事項
  • AGENTS.md 膨脹成鉅細靡遺的大全 — 專注於代理真正需要的內容,其餘細節連結至 README 供人閱讀。
搭配使用: filesystem · git

在 monorepo 中為各套件分別產生 AGENTS.md

👤 Monorepo 維護者 ⏱ ~30 min intermediate

何時使用: 各套件有不同的慣例,單一根目錄的 AGENTS.md 不足以涵蓋所有情況。

步驟
  1. 掃描各套件
    Use agent-rules-skill. For each package in packages/, generate a tailored AGENTS.md capturing its specifics.✓ 已複製
    → 每個套件各自產生一份 AGENTS.md
  2. 建立根目錄摘要
    Generate a root AGENTS.md that links to per-package files and lists shared rules.✓ 已複製
    → 根目錄檔案含各套件連結

結果: 代理能根據當前所在的套件自動取得正確的背景脈絡。

搭配使用: filesystem

讓 AGENTS.md 與持續演進的專案保持同步

👤 AGENTS.md 容易快速過時的專案 ⏱ ~10 min beginner

何時使用: 你新增了建置指令或變更了慣例,但 AGENTS.md 的內容已不再正確。

步驟
  1. 差異比對
    Use agent-rules-skill. Compare current AGENTS.md to what the repo actually has now. What's stale?✓ 已複製
    → 列出所有落差項目
  2. 更新
    Update only the stale parts; leave human-written sections alone.✓ 已複製
    → 最小化差異,保留人工撰寫的說明

結果: AGENTS.md 維持可信賴的狀態。

搭配使用: git

組合

與其他 MCP 搭配,撬動十倍槓桿

agent-rules-skill + filesystem

直接將產生的檔案寫入專案

Write the draft to AGENTS.md at repo root.✓ 已複製
agent-rules-skill + git

以專注的提交記錄變更

Commit the new AGENTS.md with a message describing what it covers.✓ 已複製

工具

此 MCP 暴露的能力

工具輸入參數何時呼叫成本
scan_repo repo path 任何專案的第一步 0
draft_agents_md scan output 起草新檔案時使用 0
diff_check existing AGENTS.md + current repo 檢查內容是否已過時 0

成本與限制

運行它的成本

API 配額
None
每次呼叫 Token 數
適中——專案掃描加上簡短輸出
費用
Free
提示
在大型 monorepo 中針對特定目錄執行;掃描整個專案會消耗大量 token。

安全

權限、密鑰、影響範圍

憑證儲存:
資料出站: 掃描過程中專案內容會經由 Claude API 傳輸

故障排查

常見錯誤與修復

Generated commands don't match CI

請對照實際的 CI 設定檔驗證;技能是從常見檔案推斷指令,不一定完全正確

File is too long

提示要求更精簡;agents.md 原本就應保持簡短

替代方案

agent-rules-skill 對比其他方案

替代方案何時用它替代權衡
Manually writing AGENTS.md慣例清晰的小型專案可行但容易過時,需要有紀律地持續維護
Cursor-specific .cursorrules只使用 Cursor 的情況不具可攜性;AGENTS.md 可跨代理工具使用

更多

資源

📖 閱讀 GitHub 上的官方 README

🐙 查看未解決的 issue

🔍 瀏覽全部 400+ MCP 伺服器和 Skills