مواصفة بروتوكول استدعاء الأدوات الشامل (UTCP)
يحتوي هذا المستودع على الوثائق الرسمية لمواصفة بروتوكول استدعاء الأدوات الشامل (UTCP). يعد UTCP معيارًا حديثًا ومرنًا وقابلاً للتطوير لتعريف والتفاعل مع الأدوات عبر بروتوكولات الاتصال المختلفة.
ما هو UTCP؟
يوفر UTCP طريقة موحدة لأنظمة الذكاء الاصطناعي والعملاء الآخرين لاكتشاف واستدعاء الأدوات من مزودين مختلفين، بغض النظر عن البروتوكول المستخدم (HTTP، WebSocket، CLI، إلخ). تحدد هذه المواصفة:
- آليات اكتشاف الأدوات
- تنسيقات استدعاء الأدوات
- إعدادات المزود
- طرق المصادقة
- معالجة الاستجابات
المساهمة في المواصفة
نرحب بالمساهمات في مواصفة UTCP! إليك كيفية المساهمة:
- قم بعمل فورك للمستودع: أنشئ نسخة خاصة بك من مستودع المواصفة
- قم بإجراء التعديلات: حدّث أو أضف الوثائق حسب الحاجة
- قدّم طلب دمج: افتح طلب دمج بالتغييرات الخاصة بك للمراجعة
- شارك في النقاشات: انضم إلى الحوار حول التغييرات المقترحة
- تأكد من أن تعديلاتك تتماشى مع الرؤية والأهداف العامة لـ UTCP
- اتبع هيكل وتنسيق الوثائق المعتمد
- أضف أمثلة عند إضافة ميزات أو مفاهيم جديدة
- حدّث الأقسام ذات الصلة للحفاظ على الاتساق في جميع الوثائق
بناء الوثائق محليًا
المتطلبات المسبقة
لبناء ومعاينة موقع الوثائق محليًا، ستحتاج إلى:
- إصدار روبي 2.5.0 أو أعلى
- RubyGems
- Bundler
الإعداد
- استنسخ المستودع:
git clone https://github.com/universal-tool-calling-protocol/utcp-specification.git
cd utcp-specification
``
- تثبيت التبعيات:
`bash
bundle install
`
تشغيل موقع التوثيق
لبناء وتشغيل الموقع محلياً:
سيؤدي ذلك إلى بدء خادم ويب محلي على http://localhost:4000 حيث يمكنك معاينة الوثائق.هيكلية التوثيق
تنظم وثائق UTCP على النحو التالي:
index.md: الصفحة الرئيسية ومقدمة عن UTCP
docs/
introduction.md: مقدمة مفصلة والمفاهيم الأساسية
for-tool-providers.md: دليل لتنفيذ مزودي الأدوات
for-tool-callers.md: دليل لتنفيذ مستدعي الأدوات
providers/: توثيق لكل نوع من المزودين
http.md: مزود HTTP
websocket.md: مزود WebSocket
cli.md: مزود CLI
sse.md: مزود Server-Sent Events
إلخ.
implementation.md: إرشادات التنفيذ وأفضل الممارساتالعمل مع المواصفة
تعديل الوثائق
تُكتب الوثائق بصيغة Markdown مع مقدمة Jekyll. عند إجراء تغييرات:
- تأكد من أن Markdown الخاص بك يتبع النمط المعتمد
- راجع التغييرات محليًا قبل تقديم طلبات السحب
- حافظ على تحديث الأمثلة بما يتوافق مع أحدث المواصفات
- حدّث عناصر التنقل في
_config.yml إذا أضفت صفحات جديدةتنظيم الملفات
عند إضافة وثائق جديدة:
- ضع توثيق المزودين في
docs/providers/`
التحكم بالإصدارات
تتبع مواصفة UTCP نظام الترقيم الدلالي للإصدارات:
- الإصدارات الرئيسية (1.0، 2.0): تغييرات جذرية في البروتوكول
- الإصدارات الفرعية (1.1، 1.2): ميزات جديدة متوافقة مع الإصدارات السابقة
- إصدارات التصحيح (1.0.1، 1.0.2): إصلاحات للأخطاء وتوضيحات متوافقة مع الإصدارات السابقة
الرخصة
توزع هذه المواصفة بموجب رخصة موزيلا العامة 2.0 (MPL-2.0).