البناء بمساعدة الذكاء الاصطناعي
كل صفحة في هذا الموقع متاحة أيضاً بصيغة Markdown، حتى يقرأ وكيل البرمجة (AI coding agent) أو المساعد في المحادثة التوثيق دون تخمين.
ملفات لأدوات الذكاء الاصطناعي
| الملف | ماذا فيه |
|---|---|
/ar/llms.txt | فهرس لكل الصفحات، وفي أوله تعليمات لوكلاء الذكاء الاصطناعي |
/ar/llms-full.txt | كل الأدلة وكل عقود الـ Endpoints (المسارات والـ Parameters وحقول الطلب والرد) في ملف واحد |
أي صفحة مع إضافة .md | الصفحة بصيغة Markdown، مثل /ar/record-a-sale.md، والصفحة الرئيسية هي /ar/index.md |
/skill/kosoor-merchant-api/SKILL.md | الـ Agent skill: قواعد هذا الـ API في ملف قصير واحد |
وللموقع الإنجليزي نسخه الخاصة بدون /ar، مثل /llms.txt. أما الـ Skill فملف واحد بالإنجليزية.
في كل صفحة
فوق كل صفحة أربعة أزرار:
- نسخ الصفحة بصيغة Markdown ينسخ الصفحة جاهزة للصقها في محادثة.
- عرض بصيغة Markdown يفتح نسخة الصفحة بصيغة
.md. - فتح في Claude و فتح في ChatGPT يبدآن محادثة تقرأ الصفحة.
تثبيت الـ Agent skill
تعطي الـ Skill وكيل البرمجة أهم القواعد عندما يكتب كوداً يتعامل مع هذا الـ API: أن يرسل Idempotency-Key، وأن يعتمد على code، وأن يبني بمفتاح اختبار، وأن يأخذ المعرّفات من الكتالوج، وأين يقرأ الباقي.
في Claude Code، احفظها كـ Skill للمشروع، فيحصل عليها كل من يعمل على المستودع:
mkdir -p .claude/skills/kosoor-merchant-api
curl -fsSL https://docs.kosoor.com.sa/skill/kosoor-merchant-api/SKILL.md \
-o .claude/skills/kosoor-merchant-api/SKILL.md
أو كـ Skill شخصية لكل المشاريع على جهازك:
mkdir -p ~/.claude/skills/kosoor-merchant-api
curl -fsSL https://docs.kosoor.com.sa/skill/kosoor-merchant-api/SKILL.md \
-o ~/.claude/skills/kosoor-merchant-api/SKILL.md
يحمّل Claude Code الـ Skill عندما تتعلق المهمة بـ Kosoor API. ولأي وكيل آخر، أضف محتوى الملف إلى التعليمات التي يقرؤها، أو وجّهه إلى https://docs.kosoor.com.sa/ar/llms.txt.
أعطِ الوكيل مفتاح اختبار
دع الوكيل يبني ويجرّب على بيئة الاختبار بمفتاح اختبار (ksr_test_...)، وليس بمفتاح فعلي أبداً. وضع المفتاح في متغير بيئة (Environment variable) أو في ملف محلي يتجاهله المستودع، وليس في الـ Prompt ولا في الكود. التفاصيل في وضع الاختبار.