एक AGENTS.md फ़ाइल स्टेप-बाय-स्टेप बनाएँ
AGENTS.md फ़ाइल आपके रेपो रूट (repo root) में एक सिंगल मार्कडाउन फ़ाइल होती है। यह AI कोडिंग एजेंट्स को बताता है कि उन्हें कैसे काम करना है। इसमें बिल्ड स्टेप्स, टेस्ट और नियम शामिल होते हैं।
Python FastAPI प्रोजेक्ट के लिए इसे बनाने के लिए इन स्टेप्स का पालन करें।
1. स्टैक (stack) को परिभाषित करें
एक वाक्य से शुरुआत करें। एजेंट को भाषा, फ्रेमवर्क और डेटाबेस के बारे में बताएं। उदाहरण: FastAPI, SQLite और pytest का उपयोग करके Python में एक URL shortener API।
2. सेटअप कमांड प्रदान करें
एजेंट को चलाने के लिए वास्तविक कमांड दें। प्लेसहोल्डर्स का उपयोग न करें।
- Setup:
python -m venv .venv && source .venv/bin/activate - Run:
uvicorn app.main:app --reload
3. टेस्टिंग का मानक तय करें
यह अत्यंत महत्वपूर्ण है। एजेंट अपने काम की जांच करने के लिए टेस्ट का उपयोग करता है।
- Run
pytest - Run
ruff check - Run
mypy
4. स्ट्रक्चर का मैप तैयार करें
अपने फोल्डर्स की सूची दें ताकि एजेंट को हर फ़ाइल खोजने की ज़रूरत न पड़े।
app/main.py: route handlersapp/db.py: SQLite accessmigrations/: जनरेट किया गया SQL (एडिट न करें)
5. कन्वेंशन (conventions) परिभाषित करें
स्पष्ट रहें। अस्पष्ट नियम बेकार होते हैं।
- सभी इनपुट वैलिडेशन के लिए Pydantic का उपयोग करें।
- क्लाइंट एरर्स के लिए HTTPException का उपयोग करें।
- mypy को क्लीन रखने के लिए हर चीज़ को टाइप (type) करें।
6. "क्या न करें" (Don'ts) की सूची बनाएं
सख्त सीमाएं तय करके गलतियों को रोकें।
- माइग्रेशन को मैन्युअली एडिट न करें।
- सीधे
mainमें कमिट न करें। - नॉन-लोकल डेटाबेस पर कभी भी seed scripts न चलाएं।
यह क्यों काम करता है
जब आप किसी AI एजेंट को "Add a DELETE endpoint" जैसा टास्क देते हैं, तो वह सबसे पहले इस फ़ाइल को पढ़ता है।
AGENTS.md फ़ाइल के साथ, एजेंट:
- जानता है कि कोड ठीक कहाँ जोड़ना है।
- आपके विशिष्ट टेस्टिंग टूल्स का उपयोग करता है।
- बिना सवाल पूछे आपके स्टाइल का पालन करता है।
- आपके मेन कोड को खराब करने के बजाय एक नई ब्रांच खोलता है।
इस फ़ाइल के बिना, एजेंट अंदाज़ा लगाता है। वह गलत टेस्ट रनर का उपयोग कर सकता है या उन फ़ाइलों को एडिट कर सकता है जिन्हें उसे नहीं छूना चाहिए।
इस फ़ाइल को कोड की तरह मानें। यदि आपका वर्कफ़्लो बदलता है, तो फ़ाइल को तुरंत अपडेट करें। एक पुरानी (stale) फ़ाइल से गलतियाँ हो सकती हैं।
Source: https://dev.to/wolfejam/agentsmd-hands-on-build-one-step-by-step-and-watch-an-agent-use-it-3g27
वैकल्पिक लर्निंग कम्युनिटी: https://t.me/GyaanSetuAi