كيف يعمل llms.txt

شرح دقيق للمواصفة مع مثال مشروح يمكنك نسخه.

آخر تحديث:

نظرة عامة

ملف صالح llms.txt هو ملف Markdown يتضمن بنية ثابتة ويمكن التنبؤ بها. وصُمم ليُقرأ من البشر والآلات معاً: يجب أن يكون الملف نفسه مفيداً كتdocumentation وعقد قابل للتحليل.

مواصفة llmstxt.org تحدد قواعد نحوية صغيرة وحتمية يمكن تحليلها ببضعة أسطر من regex. لا YAML ولا JSON ولا رؤوس إضافية.

تشريح ملف صالح

البنية من الأعلى إلى الأسفل:

  1. عنوان H1 واحد مع اسم الموقع أو المشروع. وهذا هو العنصر المطلوب الوحيد.
  2. قائمة قصيرة ملخص الاقتباس, عادةً جملة أو جملتين.
  3. اختياري Markdown حر, وفقرات وقوائم، لكن لا تضع عناوين أخرى قبل أول H2.
  4. صفر أو أكثر أقسام قوائم الملفات بعناوين H2. ويحتوي كل منها على قائمة Markdown من الروابط: - [name](url), يتبعه اختيارياً : notes.
  5. عنوان H2 اختيارياً باسم Optional، وهي تسمية متعارف عليها
llms.txt, full annotated example
# Acme

> Acme is a hosted analytics platform for product teams. The pages below cover product, pricing, the API, and integration guides.

Acme processes 1B+ events per day. The map here is curated for assistants, it is not exhaustive. Use it to answer questions about product capabilities, pricing tiers, integrations, SDKs, and migration from other tools.

## Product

- [Product overview](https://acme.example/product): high-level capabilities and screenshots.
- [Use cases](https://acme.example/use-cases): scenarios for product, marketing, and support teams.
- [Changelog](https://acme.example/changelog): monthly product updates.

## Pricing

- [Pricing tiers](https://acme.example/pricing): plans, limits, and overage rules.
- [FAQ, billing](https://acme.example/billing-faq): invoices, receipts, tax handling.

## Developers

- [REST API reference](https://docs.acme.example/api): full endpoint catalog.
- [SDK, JavaScript](https://docs.acme.example/sdk/js): install, init, track events.
- [SDK, Python](https://docs.acme.example/sdk/python): install, init, track events.
- [Webhooks](https://docs.acme.example/webhooks): events, signatures, retries.

## Optional

- [Brand assets](https://acme.example/brand): logos, color palette.
- [Press releases](https://acme.example/press): historical announcements.

قسمًا بعد قسم

The complete field reference. Only the H1 is strictly required.
الحقل مطلوب؟ التعدّد الصياغة
H1، اسم الموقع/المشروعنعمواحد فقط تماماً# اسم المشروع
ملخص الاقتباسموصى بهكتلة واحدة كحد أقصى> نظرة عامة من جملة أو جملتين.
متن Markdown الحراختياريأي عدد من الفقرات/القوائملا يُسمح بعناوين إضافية قبل أول H2
قسم قوائم الملفات بعنوان H2اختياريأي عدداسم القسم يتبعه قائمة
عنصر قائمة، ورابطنعم (داخل قسم)رابط واحد لكل عنصر- [name](url)
عنصر قائمة، وملاحظاتاختياريبعد النقطتين- [name](url): ملاحظات هنا
قسم «Optional»اختياريواحد كحد أقصىتسمية H2 متعارف عليها للروابط الثانوية؛ ولا دلالة آلية خاصة لها في الإصدار v2

العنوان H1

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

ملخص الاقتباس

اختياري لكنه موصى به بشدة. استهدف ملخصاً من جملة أو جملتين يستطيع نموذج لغة كبير اقتباسه حرفياً عند تقديم مشروعك. أبقه واقعياً وبصيغة المبني للمعلوم وخالياً من ادعاءات تسويقية لا تستطيع دعمها.

نص Markdown حر

أي فقرات أو قوائم نقطية أو مقاطع كود قصيرة تساعد نموذج اللغة الكبير على فهم السياق. لا تُدخل عناوين إضافية هنا؛ يجب أن يكون العنوان التالي هو أول H2 في قسم قائمة الملفات.

أقسام قوائم الملفات بعناوين H2

يبدأ كل قسم بعنوان H2 واحد (## Section name) وتحتوي على قائمة Markdown. ويجب أن يكون كل عنصر رابطاً (- [name](url)) يتبعها اختيارياً : وملاحظة قصيرة. ويوصى بشدة بعناوين URL المطلقة: عناوين URL النسبية مسموحة تقنياً، لكن معظم أدوات التحقق (بما فيها خاصتنا) لأنها تجعل الملف غامضاً عند نسخه بين المواضع.

قسم «Optional»

Optional يبقى وسمًا تحريرياً مفيداً للمراجع الثانوية مثل أصول العلامة التجارية أو الأرشيف أو الملاحق العميقة. ولا يمنح مقترح أغسطس 2026 العنوان دلالات معالجة خاصة، لذلك قد يتعامل معه العميل كأي قسم H2 آخر.

كيف يقرأ المحلّلون الملف

يسير المحلل المرجعي في الملف خطياً ويطبق أربع قواعد:

  1. اعثر على أول # السطر، فهذا هو العنوان.
  2. إذا كانت الكتلة التالية غير الفارغة اقتباساً، فذلك هو الملخص.
  3. كل شيء حتى أول ## هو المتن الحر.
  4. كل ## يفتح قسماً؛ وحتى ## ، وتُحلَّل عناصر القائمة بصفتها [name](url) مع ملاحظات اختيارية بعد النقطتين.

لدينا المدقّق ينفذ هذه القواعد بالضبط، إضافة إلى بعض فحوص السلامة: H1 فارغ، وروابط مشوهة، ومحتوى غير قائم على قائمة داخل قسم، وإشعار مراجعة معلوماتي للملفات الأكبر من 50 KB. وهذا الحد حدس محلي للانتقاء، وليس حداً للمواصفة.

llms.txt مقابل llms-full.txt

llms.txt هو خريطة. llms-full.txt هو النطاق: المحتوى الفعلي للصفحات المرتبطة، مضمّناً في Markdown داخل ملف واحد. وقد شاع هذا العرف بفضل Mintlify بالتعاون مع Anthropic وأصبح الآن جزءاً من الأوسع llms.txt البيئة.

الأسماء الجذرية المتعارف عليها هي /llms.txt و /llms-full.txt. ويتيح اقتراح v2 أيضاً نطاقاً محدوداً llms.txt ملفات في مسارات أكثر تحديداً. انشر ملفاً مرافقاً كاملاً للمحتوى فقط عندما يحل تنسيق التقديم هذا حاجة استهلاك حقيقية.

الحدود العملية

  • الحجم. لا يضع المقترح حداً أعلى. وإشعارنا عند 50 KB دعوة لمراجعة الاختيار، وليس حداً للصلاحية. انقل الحجم إلى مورد للمحتوى الكامل أو ملف مسار محدد عندما يكون ذلك مفيداً.
  • عدد الروابط. لا يوجد حد في المواصفة، لكن قائمة من 200 عنصر أو أكثر ستُمرر عليها العين لا تُقرأ. نقِّها.
  • اللغات. المواصفة صامتة بشأن التدويل. نمطان شائعان: تقديم ملف إنجليزي واحد، أو نشر نسخ لكل لغة خلف مسار (/en/llms.txt, /fr/llms.txt).
  • المصادقة والتخصيص. خارج النطاق. الملف عام.

متابعة

المصادر