دليل تبديل مستندات الكوربوس

نظرة سريعة

ما: استبدال أو توسيع مجموعة الوثائق المستخدمة بواسطة decision_gate_docs_search و MCP resources/list + resources/read.

لماذا: قم بتخصيص إرشادات وقت تشغيل LLM لبيئتك أو سياساتك أو وثائقك الداخلية.

أين: decision-gate.toml تحت [docs].

كيفية بناء مجموعة الوثائق

الإعدادات الافتراضية المدمجة (وقت التجميع، بدون إدخال/إخراج شبكة).
مستندات إضافية اختيارية محملة من docs.extra_paths (ملفات أو دلائل).

يتم تحميل الوثائق مرة واحدة عند بدء تشغيل الخادم وتخزينها في كتالوج في الذاكرة.

الخطوة 1: إعداد مستنداتك

المتطلبات:

ملفات Markdown (.md) فقط.
يجب أن يتضمن كل مستند عنوانًا برمز # Title.
استخدم ## / ### العناوين للأقسام القابلة للبحث.
احتفظ بالملفات تحت حد docs.max_doc_bytes المكون.

ملاحظات:

تصبح أسماء الملفات معرفات الوثائق (م sanitized إلى أحرف صغيرة + شرطات سفلية).
يتم إعطاء الوثائق المخصصة دور pattern بشكل افتراضي.
يتم تخطي الملفات الفارغة مع تحذيرات.

الخطوة 2: تحديث decision-gate.toml

استبدال مجموعة البيانات الافتراضية بدليل مخصص:

[docs]
enabled = true
enable_search = true
enable_resources = true
include_default_docs = false
extra_paths = ["./my-docs"]
max_doc_bytes = 262144
max_total_bytes = 1048576
max_docs = 32
max_sections = 10

قم بتمديد مجموعة البيانات الافتراضية مع بعض الملفات الإضافية:

[docs]
enabled = true
enable_search = true
enable_resources = true
include_default_docs = true
extra_paths = ["./overrides/llm_playbook.md", "./runbooks"]

السلوك المتوقع:

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

الخطوة 3: ضمان رؤية الأداة (اختياري)

بحث المستندات هو أداة. إذا قمت بتصفية الأدوات، تأكد من أنها مرئية:

[server.tools]
mode = "filter"
allowlist = ["decision_gate_docs_search", "scenario_define", "scenario_start"]
denylist = []

إذا كان docs.enabled = false أو docs.enable_search = false، فإن الأداة مخفية وتعيد المكالمات UnknownTool.

الخطوة 4: إعادة تشغيل الخادم

تُحمَّل الوثائق عند بدء التشغيل فقط. أعد التشغيل لالتقاط محتوى جديد. تُطبع التحذيرات حول الوثائق التي تم تخطيها إلى stderr.

الخطوة 5: التحقق من صحة المجموعة

البحث (الأدوات/الاتصال):

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "decision_gate_docs_search",
    "arguments": { "query": "precheck vs live", "max_sections": 3 }
  }
}

قائمة الموارد (resources/list):

{ "jsonrpc": "2.0", "id": 2, "method": "resources/list" }

الموارد المقروءة (resources/read):

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "resources/read",
  "params": { "uri": "decision-gate://docs/custom/my_doc" }
}

استكشاف الأخطاء وإصلاحها

Search returns no results: empty query returns an overview; otherwise تأكيد وجود العناوين وأن النص قد تم تحميله.
فشل الخادم عند بدء التشغيل: مسار في docs.extra_paths مفقود.
الأداة مفقودة من tools/list: تحقق من [docs] التبديلات و[server.tools].
فشل قراءة المورد: تأكد من أن URI يتطابق مع resources/list.