mmo.vn

Tạo AGENTS.md / CLAUDE.md cho repo

File hướng dẫn để Claude Code, Copilot, Codex, Cursor… hiểu dự án ngay từ đầu: chạy lệnh nào để build và test, quy ước code, việc không được làm. Điền vài ô, tải file đặt ở thư mục gốc repo.

Loại file

Thêm quy tắc an toàn hay dùng

AGENTS.md


			

Mẹo để agent làm theo

  • Ghi lệnh chính xác, đúng như gõ trong Terminal. Agent sẽ chạy đúng lệnh đó để kiểm tra việc nó làm.
  • Ngắn và cụ thể: "Không dùng any" tốt hơn "viết code sạch". File quá dài làm agent bỏ sót ý.
  • Cập nhật khi dự án đổi: coi file như tài liệu cho người mới vào đội, sửa ngay khi đổi lệnh hay cấu trúc.

Muốn tách quy trình riêng thành skill? Dùng trình tạo SKILL.md. Trước khi dán code cho AI, kiểm tra lộ API key.

Đọc thêm về chủ đề này

Câu hỏi thường gặp

Nên chọn AGENTS.md hay CLAUDE.md?

AGENTS.md là định dạng chung được nhiều agent đọc, như Codex, Cursor, GitHub Copilot; CLAUDE.md là file Claude Code đọc khi bắt đầu làm việc trong repo. Nếu đội dùng nhiều công cụ, có thể giữ nội dung chính trong AGENTS.md và tạo CLAUDE.md chỉ có một dòng @AGENTS.md để Claude Code nạp cùng nội dung.

Thông tin tôi điền có được gửi đi không?

Không. File được tạo ngay trên trình duyệt; nội dung bạn điền chỉ được lưu nháp trong trình duyệt (localStorage) để lần sau mở lại vẫn còn, không gửi lên máy chủ mmo.vn.

Đặt file ở đâu?

Đặt ở thư mục gốc repo và commit cùng code để cả đội và agent dùng chung. Dự án lớn có thể đặt thêm file trong thư mục con cho phần riêng; agent thường ưu tiên file gần thư mục đang làm việc nhất.

Agent có chắc chắn làm theo file này không?

Không tuyệt đối. File là hướng dẫn được đưa vào ngữ cảnh, agent thường làm theo nhưng vẫn có thể bỏ sót, nhất là khi file dài hoặc có ý mâu thuẫn. Quy tắc quan trọng như không đọc .env hay không push nên chặn thêm bằng cài đặt quyền của công cụ hoặc kiểm tra tự động (CI).

Có nên ghi API key, mật khẩu vào file này?

Không. AGENTS.md, CLAUDE.md thường được commit lên Git và đưa cho mô hình AI ở mỗi phiên, nên chỉ ghi tên biến môi trường cần có (ví dụ trong .env.example), không ghi giá trị thật. Trước khi commit, có thể dán nội dung vào công cụ kiểm tra lộ API key.