कोडिंग एजेंट के लिए AGENTS.md फ़ाइल कैसे लिखें

AGENTS.md आपकी रिपॉज़िटरी के रूट में रखी एक सामान्य Markdown फ़ाइल है, जो कोडिंग एजेंट को बताती है कि प्रोजेक्ट पर कैसे काम करना है: कौन-सी कमांड चलानी हैं, कोड कहाँ है और किन चीज़ों को नहीं छूना है। इसमें कोई सेक्शन अनिवार्य नहीं है। इसे छोटा रखें, हर नियम ऐसा लिखें जिसे जाँचा जा सके, और पक्का करें कि हर एजेंट इसे लोड करता है।

यह गाइड बताती है कि इसमें क्या लिखें, एक टेम्पलेट देती है, समझाती है कि Claude Code और Gemini CLI यह फ़ाइल कैसे ढूँढते हैं, और एक छोटा टेस्ट सुझाती है। जब आप Mono by Reunified के ज़रिए फ़ोन से एजेंट शुरू करते हैं, तब भी यही कदम लागू होते हैं।

1. तय करें कि फ़ाइल में क्या जाए

agents.md साइट इसे एजेंट के लिए README कहती है। वे तथ्य शामिल करें जो हर सेशन को चाहिए, और वह सब छोड़ दें जो एजेंट कोड से ख़ुद जान सकता है।

मोनोरिपो में आप हर पैकेज के अंदर अलग AGENTS.md रख सकते हैं। सबसे पास वाली फ़ाइल को प्राथमिकता मिलती है, और चैट में दिया गया सीधा निर्देश उससे भी ऊपर रहता है।

2. छोटे टेम्पलेट से शुरू करें

यह “tidy-recipes” का एक काल्पनिक उदाहरण है, जो pnpm इस्तेमाल करने वाला एक TypeScript वेब ऐप है:

# AGENTS.md

## Overview
TypeScript web app for saving recipes. Components live in src/components.

## Setup
- `pnpm install`

## Test and lint
- `pnpm test` and `pnpm lint`

## Code style
- TypeScript only. One component per file.

## Boundaries
- Never edit db/migrations/.
- Ask before adding a dependency.

## Before you finish
- Run `pnpm test` and `pnpm lint`.
- List the files you changed and the test results.

सिर्फ़ वही कमांड लिखें जो आपने इस रिपॉज़िटरी में चलाकर देखी हैं। गलत कमांड पर भी एजेंट भरोसा कर लेगा।

3. ऐसे नियम लिखें जिनका पालन जाँचा जा सके

अच्छा नियम ऐसा होता है कि बाद में आप जाँच सकें कि एजेंट ने उसका पालन किया या नहीं।

सीमाएँ “कभी नहीं” और “पहले पूछो” वाले नियमों के रूप में लिखें, हर पंक्ति में एक।

4. Claude Code और Gemini CLI से इसे पढ़वाएँ

agents.md साइट Codex, Gemini CLI, opencode और दूसरे एजेंट की सूची देती है जो इस फ़ॉर्मैट का समर्थन करते हैं, लेकिन कुछ में पहले कोई सेटिंग करनी पड़ती है।

डिफ़ॉल्ट रूप से Claude Code के नए वर्शन AGENTS.md तभी पढ़ते हैं जब वर्किंग डायरेक्टरी में या उसके ऊपर कोई CLAUDE.md, .claude/CLAUDE.md या CLAUDE.local.md न हो (उसके मेमोरी दस्तावेज़ देखें)। अगर इनमें से कोई फ़ाइल मौजूद है या आपके पास पुराना वर्शन है, तो CLAUDE.md से AGENTS.md इम्पोर्ट करें। tidy-recipes प्रोजेक्ट में एक पुरानी CLAUDE.md है, इसलिए उसमें सबसे ऊपर यह पंक्ति जोड़ें और सिर्फ़ Claude के लिए नोट उसके नीचे रखें:

@AGENTS.md

Prefer small commits.

नया सेशन शुरू करें, /context चलाएँ और जाँचें कि Memory files के नीचे CLAUDE.md दिख रही है। CLAUDE.md न हो तो /memory उसकी जगह AGENTS.md का पाथ दिखाता है।

Gemini CLI डिफ़ॉल्ट रूप से GEMINI.md पढ़ता है। AGENTS.md जोड़ने के लिए प्रोजेक्ट की .gemini/settings.json में यह डालें (उसके GEMINI.md दस्तावेज़ देखें):

{
  "context": {
    "fileName": ["AGENTS.md", "GEMINI.md"]
  }
}

नया सेशन शुरू करें, फिर /memory show चलाकर देखें कि क्या लोड हुआ। दूसरे एजेंट के लिए उनके दस्तावेज़ देखें।

5. छोटे काम से फ़ाइल टेस्ट करें

नए सेशन में एजेंट को यह काम दें:

पहले उन प्रोजेक्ट नियमों की सूची दो जो तुमने लोड किए हैं, और बताओ कि हर नियम किस फ़ाइल से आया। फिर src/components/SaveButton.tsx में बटन का टेक्स्ट “Save recipe” से बदलकर “Save” करो। और कुछ मत बदलो।

नतीजे को फ़ाइल से मिलाकर देखें:

• उसने AGENTS.md का नाम लिया (या इम्पोर्ट वाली CLAUDE.md का)।
• उसने pnpm test और pnpm lint चलाए और नतीजे बताए।
• उसने db/migrations/ को नहीं छुआ और कोई डिपेंडेंसी नहीं जोड़ी।
• उसने बदली गई फ़ाइलों की सूची दी।

बदलाव की पुष्टि ख़ुद git diff से करें (AI के कोड बदलावों की समीक्षा देखें)। अगर एजेंट कोई नियम नहीं बता पाता, तो शायद फ़ाइल लोड नहीं हुई, इसलिए चरण 4 पर लौटें। अगर उसने नियम बताया पर उसका पालन नहीं किया, तो नियम को और ठोस बनाएँ।

6. इसे छोटा और अपडेट रखें

Claude Code के दस्तावेज़ CLAUDE.md को 200 पंक्तियों से कम रखने का सुझाव देते हैं, क्योंकि लंबी फ़ाइलें ज़्यादा कॉन्टेक्स्ट लेती हैं और उनका पालन कम भरोसेमंद ढंग से होता है। AGENTS.md के लिए भी यही लक्ष्य रखें। कॉन्टेक्स्ट भरने पर क्या होता है, यह कॉन्टेक्स्ट विंडो गाइड बताती है।

जब एजेंट कोई गलती दोहराए, तो फ़ाइल अपडेट करें, और पुरानी पड़ चुकी कमांड व आपस में टकराने वाले नियम हटा दें। इसे कमिट करें और इसके बदलावों की समीक्षा कोड की तरह करें।

यह फ़ाइल एजेंट को दिशा देती है, किसी बात को ज़बरदस्ती लागू नहीं करती। किसी कार्रवाई को रोकने के लिए एजेंट की अनुमति सेटिंग इस्तेमाल करें या उसका अनुरोध अस्वीकार करें (टूल अनुमति गाइड देखें)।

Mono में एजेंट आपके कंप्यूटर पर प्रोजेक्ट की वर्किंग डायरेक्टरी में शुरू होता है, जहाँ वह ये फ़ाइलें ढूँढता है। आप AGENTS.md, CLAUDE.md या .gemini/settings.json को Mono के एडिटर में खोल सकते हैं, फ़ोन से भी, और बदलाव अपने-आप सेव होते हैं। फ़ाइल बनाने के लिए एजेंट से कहें या प्रोजेक्ट कार्ड से टर्मिनल खोलें। Mono फ़ाइल की जाँच नहीं करता और न ही यह बदलता है कि एजेंट कौन-सी फ़ाइल लोड करे। Mono अभी उपलब्ध नहीं है, लेकिन आप प्रतीक्षा सूची में जुड़ सकते हैं।