पाठ 10 / 25

Descriptions और Parameter Docs

ऐसे descriptions लिखें जो बताएँ tool क्या करता है, कब उपयोग करें और क्या लौटाता है।

Model इसे मैनुअल की तरह पढ़ता है

Description ही आपके tool के बारे में model का एकमात्र ज्ञान है। मज़बूत description उद्देश्य, कब उपयोग करें (और कब नहीं), उदाहरण सहित ज़रूरी inputs का रूप, और क्या लौटता है बताता है। "अधिकतम 20 नतीजे लौटाता है" जैसी सीमाएँ और "email भेजता है" जैसे side effects का उल्लेख करें।

कमज़ोर बनाम मज़बूत

मज़बूत संस्करण format, दायरे और side effects के अंदाज़े को हटाता है।

Weak:
  "Searches orders."

Strong:
  "Search the customer's orders by status or date range. Use for questions
   about past or current orders. Dates are ISO format, e.g. 2026-09-30.
   Returns up to 20 orders as {id, status, total}. Read-only."

त्वरित जाँच: Date parameter सही उपयोग करने में model की सबसे ज़्यादा मदद क्या करता है?

  • अपेक्षित format उदाहरण के साथ
  • लेखक का नाम
  • Git commit hash
  • Server का IP address
Answer

अपेक्षित format उदाहरण के साथ — स्पष्ट format और उदाहरण वह अंदाज़ा हटाते हैं जिससे अमान्य arguments आते हैं।