تخطي إلى المحتوى
Tutorial

أضف llms.txt إلى واجهة برمجة التطبيقات الخاصة بك لإمكانية اكتشاف الذكاء الاصطناعي

| 8 min read

يُخبر llms.txt طلاب LLM بما تفعله واجهة برمجة التطبيقات (API) الخاصة بك برموز أقل بمقدار 6 مرات من رموز HTML. برنامج تعليمي خطوة بخطوة بتنسيق المواصفات، ونهج من مستويين، ومثال من العالم الحقيقي.

Digital matrix code representing machine-readable text
Photo by Markus Spiske on Unsplash

يمكنك نشر مستندات API بتنسيق HTML. يقرأها المطور، وينسخ أمر الضفيرة، ويدمج واجهة برمجة التطبيقات (API) الخاصة بك. لا يزال سير العمل يعمل. لكن هناك نسبة متزايدة من "قرائك" هم من حملة ماجستير إدارة الأعمال، وهم يقومون بمعالجة ملفاتك مستندات HTML بتكلفة: تحرق صفحة التوثيق النموذجية 12000 رمزًا مميزًا قبل أن يستخرج النموذج ملفًا عنوان URL لنقطة نهاية واحدة. علامات HTML، وتصفح Chrome، وJavaScript التي يرسلها موقعك تضيف قيمة صفرية للحصول على ماجستير.

llms.txt يحل هذا. إنه ملف Markdown عادي في جذر المجال الخاص بك والذي يصف ما تفعله واجهة برمجة التطبيقات (API) الخاصة بك، وسرد نقاط النهاية الخاصة بك، والروابط إلى المستندات التفصيلية. LLMs تقوم بتحليلها بمعدل 6 مرات أقل الرموز المميزة من HTML المكافئ. وقد اعتمدها أكثر من 849 موقعًا، بما في ذلك Anthropic وCloudflare و شريط و مينتليفي.

ما هو llms.txt (وما ليس كذلك)

ال llms.txt تحدد المواصفات التي اقترحها جيريمي هوارد ملفًا قياسيًا في /llms.txt على أي موقع. يستخدم عناوين Markdown وعلامات الاقتباس وقوائم الارتباط وصف المنتج لنماذج اللغة.

فكر في الأمر بهذه الطريقة: robots.txt يخبر برامج زحف البحث بالصفحات التي سيتم فهرستها. llms.txt يخبر النماذج اللغوية بما يفعله منتجك وأين يمكنك العثور على التفاصيل.

# robots.txt - tells crawlers what to index
User-agent: *
Allow: /

# llms.txt - tells LLMs what your product does
# Served at /llms.txt as structured Markdown

llms.txt ليس بديلاً لموقع التوثيق الخاص بك. إنه فهرس موجز، مهيأة لاستهلاك الجهاز. يمكن للبشر قراءتها أيضًا، ولكن الجمهور الأساسي هو أي ماجستير في القانون التي تحتاج إلى فهم واجهة برمجة التطبيقات (API) الخاصة بك قبل إنشاء التعليمات البرمجية أو الإجابة على الأسئلة المتعلقة بها.

تنسيق المواصفات

التنسيق مقصود في كل سطر. وهنا الهيكل:

# Product Name

> One-line product description with key capabilities.

## Section Name

- [Link Title](https://example.com/page): Brief description
- [Another Link](https://example.com/other): Brief description

## Optional: Additional sections

More structured content as needed.
  • عنوان H1: اسم المنتج أو المشروع الخاص بك. واحد لكل ملف.
  • اقتباس كتلة: وصف من سطر واحد لما يفعله المنتج.
  • أقسام H2: قم بتجميع الروابط الخاصة بك حسب الفئة (الوثائق ونقاط النهاية والأدوات).
  • قوائم الارتباط: يحتوي كل سطر على رابط Markdown متبوعًا بنقطتين ووصف.

لا يوجد HTML. لا يوجد شيء أمامي. لا يوجد بناء جملة مخصص. يمكن لأي محلل Markdown قراءته، وأي ماجستير في القانون يمكنه ذلك استخراج المعلومات المنظمة منه دون أدوات خاصة.

لماذا يهم الرموز المميزة: Markdown vs.HTML

كل LLM لديه نافذة سياقية. الرموز التي تم إنفاقها في التحليل <div class="nav-wrapper"> و <script src="analytics.js"> هي الرموز المميزة التي لا يستطيع النموذج إنفاقها على الفهم مخطط API الخاص بك. وهنا الرياضيات:

HTML documentation page:     ~12,000 tokens
Same content as Markdown:     ~2,000 tokens
Savings:                      ~83% fewer tokens

تحتوي صفحة وثائق HTML على أشرطة التنقل والتذييلات والأشرطة الجانبية والعلامات الوصفية والمضمنة مخطوطات. قم بإزالة كل ذلك وتحويله إلى Markdown، وستحصل على نفس المعلومات ما يقرب من سدس الرموز. بالنسبة لـ LLMs الذين يعملون بالقرب من حد السياق الخاص بهم، هذا هو الفرق يحدد ما إذا كان مرجع واجهة برمجة التطبيقات (API) الكامل الخاص بك يناسب موجهًا واحدًا أم لا.

النهج ذو المستويين: llms.txt + llms-full.txt

تحدد المواصفات ملفين لهما أدوار مميزة:

  • llms.txt هو الملخص. اسم المنتج، وصف سطر واحد، وقائمة من الروابط مع وصف موجز. الحجم المستهدف: أقل من 10 كيلو بايت. يقرأ LLM هذا ل فهم ما تقدمه واجهة برمجة التطبيقات الخاصة بك وتحديد الروابط التي يجب اتباعها للحصول على التفاصيل.
  • llms-full.txt هو المرجع الكامل. فهو يدمج المحتوى تشير هذه الروابط إلى ملف واحد. مخططات الطلب وأمثلة الاستجابة والمصادقة التدفقات، رموز الخطأ. الحجم المستهدف: أقل من 100 كيلو بايت. يقرأ LLM هذا عندما يحتاج إلى الإنشاء رمز العمل ضد API الخاص بك.

ابدأ بـ llms.txt. يضيف llms-full.txt بمجرد أن تريد إنشاء LLMs رمز التكامل دون اتباع الروابط الخارجية.

خطوة بخطوة: اكتب ملف llms.txt الخاص بك

1. ابدأ بهوية المنتج

افتح باستخدام H1 الذي يحتوي على اسم منتجك، متبوعًا بعلامة اقتباس تصف منتجك في جملة واحدة. كن محددًا. قم بتضمين عدد نقاط النهاية والإمكانيات الأساسية وأي عوامل تفاضلية.

# Acme API

&gt; REST API for payment processing. 12 endpoints covering charges, refunds, subscriptions, and webhooks.

## Documentation

- [API Reference](https://docs.acme.com/api): Full endpoint reference with request/response schemas
- [Authentication](https://docs.acme.com/auth): API key setup, OAuth 2.0 flows, and webhook signing
- [Quickstart](https://docs.acme.com/quickstart): Send your first charge in 5 minutes

## Endpoints

- Create charge: POST https://api.acme.com/v1/charges
- Get charge: GET https://api.acme.com/v1/charges/:id
- Create refund: POST https://api.acme.com/v1/refunds
- List subscriptions: GET https://api.acme.com/v1/subscriptions
- Create webhook: POST https://api.acme.com/v1/webhooks

يستغرق هذا الملف أقل من 800 رمزًا مميزًا للتحليل. يعرف LLM الآن أن Acme API تتعامل مع المدفوعات، ولديها 12 نقاط النهاية، ويمكن اتباع ثلاثة روابط للحصول على معلومات أعمق.

2. قم بإدراج نقاط النهاية الخاصة بك بالطرق وعناوين URL

بالنسبة لمنتجات واجهة برمجة التطبيقات (API)، قم بإدراج كل نقطة نهاية بطريقة HTTP وعنوان URL الكامل الخاص بها. هذا هو الأكثر قيمة قسم لتوليد التعليمات البرمجية. ماجستير في القانون الذي يعرف POST https://api.acme.com/v1/charges يمكن إنشاء أمر حليقة عامل أو استدعاء SDK دون قراءة مستنداتك الكاملة.

3. رابط للمواصفات التي يمكن قراءتها آليًا

إذا قمت بنشر مواصفات OpenAPI، فقم بربطها في ملف llms.txt. يمكن لـ LLMs تحليل OpenAPI JSON واستخراج مخططات المعلمات والحقول المطلوبة وأنواع الاستجابة. نفس الشيء بالنسبة لبيانات أداة MCP أو نقاط النهاية لاستبطان GraphQL.

4. أنشئ llms-full.txt للسياق العميق

خذ كل نقطة نهاية من الملخص وقم بتوسيعها بأمثلة الطلب/الاستجابة:

# Botoi API - Full Documentation

&gt; Complete endpoint reference for all 150+ developer utility endpoints.

## IP Geolocation

POST https://api.botoi.com/v1/ip/lookup

Returns city, region, country, ISP, coordinates, and timezone for any IP address.

**Request:**
\`\`\`json
{ "ip": "8.8.8.8" }
\`\`\`

**Response:**
\`\`\`json
{
  "success": true,
  "data": {
    "ip": "8.8.8.8",
    "city": "Mountain View",
    "region": "California",
    "country": "US",
    "isp": "Google LLC",
    "lat": 37.386,
    "lon": -122.0838
  }
}
\`\`\`

## Email Validation

POST https://api.botoi.com/v1/email/validate
...full documentation for every endpoint

قم بتضمين حمولات واقعية، وليس بيانات العناصر النائبة. يحتاج رمز التكامل الذي ينشئ LLM إلى رؤيته أسماء الحقول الدقيقة وأنواعها وتداخل إرجاعات واجهة برمجة التطبيقات (API) الخاصة بك.

5. يقدم مع الرؤوس الصحيحة

خدمة كلا الملفين مع text/markdown أو text/plain نوع المحتوى. إذا كنت استخدم نجينكس:

# Serve llms.txt with correct Content-Type
location = /llms.txt {
    default_type text/markdown;
    add_header X-Robots-Tag "noindex";
}

location = /llms-full.txt {
    default_type text/markdown;
    add_header X-Robots-Tag "noindex";
}

على Cloudflare Pages، أو Vercel، أو Netlify، قم بإسقاط الملفات في ملفك public/ دليل. تخدمهم منصة الاستضافة بنوع MIME الصحيح من امتداد الملف.

مثال حقيقي: ملف llms.txt الخاص بـbotoi

يخدم بوتوي llms.txt في botoi.com/llms.txt و llms-full.txt في botoi.com/llms-full.txt. فيما يلي عرض مكثف لملف الملخص:

# Botoi - Developer Utility API &amp; MCP Server

&gt; One API key, 150+ developer utility endpoints, and a 49-tool
&gt; MCP server for AI agents. IP geolocation, email validation,
&gt; DNS, hashing, JWT, QR codes, PDF generation, and more.
&gt; Sub-50ms from Cloudflare's edge. Free tier included.

## Free Online Tools

- [JSON Formatter](https://botoi.com/tools/json-formatter): Format, beautify, minify, and validate JSON data
- [Base64 Encoder/Decoder](https://botoi.com/tools/base64-encoder-decoder): Encode and decode Base64 strings
- [Hash Generator](https://botoi.com/tools/hash-generator): Generate SHA-1, SHA-256, SHA-384, SHA-512 hashes

## Botoi API

- [API Documentation](https://api.botoi.com/docs): Full API reference with interactive playground
- [OpenAPI Spec](https://api.botoi.com/openapi.json): Machine-readable OpenAPI 3.1 specification
- [MCP Tool Manifest](https://api.botoi.com/v1/mcp/tools.json): MCP tool definitions for AI agents

## API Endpoints

- IP geolocation: POST https://api.botoi.com/v1/ip/lookup
- Email validation: POST https://api.botoi.com/v1/email/validate
- DNS lookup: POST https://api.botoi.com/v1/dns/lookup
- Hash generation: POST https://api.botoi.com/v1/hash
...150+ more endpoints listed with method and URL

يسرد الملف الكامل كل أداة، وجميع نقاط نهاية API التي يزيد عددها عن 150+ مع الأساليب وعناوين URL، وخادم MCP التكوين لخمسة برامج تحرير للذكاء الاصطناعي، وأمر تثبيت TypeScript SDK. LLM يقرأ هذا يمكن أن يجيب الملف "كيف يمكنني التحقق من صحة البريد الإلكتروني باستخدام botoi؟" دون زيارة صفحة ويب واحدة.

أحضرها بنفسك:

curl -s https://botoi.com/llms.txt | head -20

تحسين المحرك التوليدي: ما وراء تحسين محركات البحث التقليدية

يعمل مُحسّنات محرّكات البحث التقليدية على تحسين زاحف Google. يعمل تحسين المحرك التوليدي (GEO) على تحسين الأداء نماذج الذكاء الاصطناعي التي تجمع الإجابات من مصادر متعددة. عندما يسأل أحد المطورين ChatGPT "ما API هل يمكنني استخدامها للتحقق من صحة البريد الإلكتروني؟"، يستمد النموذج من المصادر التي قام بتحليلها أو يمكنه جلبها.

llms.txt هو جزء من استراتيجية GEO. الصورة كاملة تشمل:

  • llms.txt و llms-full.txt للاستهلاك المباشر LLM.
  • مواصفات OpenAPI على عنوان URL عام حتى تتمكن LLMs من تحليل مخططات نقطة النهاية الخاصة بك.
  • اكتشاف خادم MCP عبر /.well-known/mcp/server-card.json لذلك منظمة العفو الدولية يمكن للمساعدين العثور على أدواتك والاتصال بها.
  • البيانات المنظمة (JSON-LD) على صفحاتك لاستخراج أكثر ثراءً.
  • robots.txt تم تهيئتها للسماح ببرامج زحف الذكاء الاصطناعي (GPTBot، ClaudeBot، بوت الحيرة).

تستهدف كل طبقة طريقة مختلفة لاكتشاف ماجستير إدارة الأعمال (LLM) لواجهة برمجة التطبيقات (API) الخاصة بك واستهلاكها. llms.txt هو نقطة البداية الأقل جهدًا والأكثر تأثيرًا.

قائمة التحقق من النشر

1. Create /llms.txt with product name, description, and key links
2. Create /llms-full.txt with full endpoint documentation
3. Add both files to your robots.txt sitemap (optional)
4. Set Content-Type to text/markdown or text/plain
5. Keep llms.txt under 10KB and llms-full.txt under 100KB
6. Update both files whenever you ship new endpoints
7. Test: curl -s https://yourdomain.com/llms.txt | wc -c

احتفظ بك llms.txt في التحكم في الإصدار جنبًا إلى جنب مع كود مصدر API الخاص بك. قم بتحديثه في نفس طلب السحب حيث قمت بإضافة نقطة نهاية جديدة. الوثائق التي لا معنى لها، سواء بالنسبة للبشر أو الآلات، تؤدي إلى تآكل الثقة.

النقاط الرئيسية

  • يقرأ حاملو شهادة LLM مستنداتك قبل أن يفعلها البشر. وكلاء الذكاء الاصطناعي ومساعدو الترميز والدردشة تقوم الواجهات بتحليل وثائق واجهة برمجة التطبيقات (API) لإنشاء التعليمات البرمجية والإجابة على الأسئلة. منحهم شكلا نظيفا.
  • تكاليف تخفيض السعر 6 مرات أقل من الرموز المميزة لـ HTML. شريط التنقل والبرامج النصية والتصميم. قم بتقديم المحتوى الذي تحتاجه LLM بالتنسيق الذي تعالجه بكفاءة أكبر.
  • يغطي ملفان كلا حالتي الاستخدام. llms.txt هو مؤشر الملخص. llms-full.txt هو المرجع الكامل. ابدأ بالملخص؛ إضافة النسخة الكاملة عندما تريد من LLMs إنشاء كود تكامل عملي.
  • اعتمد أكثر من 849 موقعًا هذا التنسيق. أنثروبي، كلاودفلير، شريط، و مينتليفي كل يخدم llms.txt. يكتسب التنسيق قوة جذب كمعيار GEO.
  • شاهده على أرض الواقع. أحضر botoi.com/llms.txt لرؤية أكثر من 150 واجهة برمجة تطبيقات لنقطة النهاية موصوفة في ملف Markdown واحد.

FAQ

ما هو llms.txt وكيف يعمل؟
llms.txt هو ملف Markdown يتم تقديمه في /llms.txt على المجال الخاص بك. فهو يصف منتجك ونقاط نهاية واجهة برمجة التطبيقات (API) وروابط الوثائق بتنسيق منظم يمكن لـ LLMs تحليله باستخدام الحد الأدنى من الرموز المميزة. فكر في الأمر على أنه ملف robots.txt للذكاء الاصطناعي: يخبر ملف robots.txt برامج الزحف بما يجب فهرسته، ويخبر llms.txt نماذج اللغة بما يقدمه موقعك.
ما عدد الرموز المميزة التي يحفظها llms.txt مقارنةً بمستندات HTML؟
يستخدم Markdown رموزًا أقل بمقدار 6 مرات تقريبًا من محتوى HTML المكافئ. يمكن لصفحة التوثيق التي تكلف 12000 رمز مميز في HTML أن يتم ضغطها إلى أقل من 2000 رمز مميز في Markdown. وهذا مهم لأن LLMs لديها نوافذ سياق محدودة، وكل رمز مميز يتم إنفاقه على التنسيق هو رمز مميز لا يتم إنفاقه على فهم واجهة برمجة التطبيقات (API) الخاصة بك.
هل أحتاج إلى كل من llms.txt وllms-full.txt؟
llms.txt هو الملخص: اسم المنتج ووصفه وقائمة الروابط. يحتوي llms-full.txt على محتوى الوثائق الكامل الذي تشير إليه الارتباطات، وهو مضمن في ملف واحد. ابدأ بـ llms.txt. قم بإضافة llms-full.txt عندما تريد أن يكون لدى LLMs سياق عميق دون اتباع روابط متعددة.
ما هي أدوات الذكاء الاصطناعي التي تقرأ llms.txt اليوم؟
يقرأ كل من Claude وChatGPT وPerplexity وCursor ملف llms.txt عند تصفح الوثائق أو الرجوع إليها. يقوم الوكلاء ومساعدو الترميز المعتمدون على MCP أيضًا بإحضاره لاكتشاف الأداة. اعتمد أكثر من 849 موقعًا هذا التنسيق اعتبارًا من أوائل عام 2026، بما في ذلك Anthropic وCloudflare وMintlify وStripe.
أين يجب أن أستضيف ملف llms.txt؟
قم بتقديمه على جذر المجال الخاص بك: https://yourdomain.com/llms.txt. استخدم نص/تخفيض أو نص/عادي كنوع المحتوى. إذا كان لديك نطاق فرعي لواجهة برمجة التطبيقات، ففكر في عرضه على كل من النطاق الرئيسي والنطاق الفرعي لواجهة برمجة التطبيقات. احتفظ بالملف بحجم أقل من 10 كيلوبايت للحصول على النسخة الموجزة.

ابدأ البناء مع botoi

أكثر من 150 نقطة نهاية API للبحث ومعالجة النصوص وتوليد الصور وأدوات المطورين. باقة مجانية، بدون بطاقة ائتمان.