مرجع أدوات MCP

MCP Tools Reference

توثيق شامل لجميع الأدوات المتاحة عبر خادم Validatar MCP، مقسّمة إلى أدوات قراءة فقط وأدوات كتابة، مع تفاصيل معاملاتها.

توثّق هذه المقالة جميع الأدوات المتاحة عبر خادم Validatar MCP. تنقسم الأدوات إلى عمليات قراءة فقط (تصفح واستعلام) وعمليات كتابة (إنشاء وتحديث وتنفيذ).

أدوات القراءة فقط (Read-Only Tools)

تسترجع هذه الأدوات معلومات من نسخة Validatar الخاصة بك دون إجراء أي تغييرات.

describe

استرجاع معلومات تفصيلية عن كائن (object) في Validatar.

المعامل	النوع	مطلوب	الوصف
object_type	enum	نعم	نوع الكائن المراد وصفه (DataSource, Schema, Table, Column, Project, Folder, Test, Job)
object_id	integer	نعم	معرّف الكائن
output_sections	list	لا	أقسام محددة لتضمينها في الاستجابة (يحدّ من مخرجات الكائنات الكبيرة)
window	string	لا	نافذة زمنية للبيانات الحساسة للوقت (مثل نتائج المهام الأخيرة)

متى تُستخدم

عندما تريد فحص التهيئة أو الحالة أو البيانات الوصفية لكائن معيّن في الكتالوج أو المشروع.

describe_quick_test

الحصول على تفاصيل اختبار سريع (quick test) محدد متاح لجدول أو عمود.

المعامل	النوع	مطلوب	الوصف
object_type	enum	نعم	Table أو Column
object_id	integer	نعم	معرّف الجدول أو العمود
template_test_id	integer	نعم	معرّف قالب الاختبار السريع المراد وصفه

متى تُستخدم

عندما تريد فهم ما يقوم به اختبار سريع محدد قبل إنشائه، بما في ذلك متغيراته وخيارات تهيئته.

list

سرد الكائنات الفرعية (child objects) التابعة لكائن أصل (parent) في Validatar.

المعامل	النوع	مطلوب	الوصف
object_type	enum	نعم	نوع الكائن الأصل
object_id	integer	نعم	معرّف الكائن الأصل
child_type	enum	نعم	نوع الكائنات الفرعية المراد سردها
filters	object	لا	معايير تصفية لتضييق النتائج
page_size	integer	لا	عدد النتائج لكل صفحة
page_index	integer	لا	رقم الصفحة للترقيم (pagination)

متى تُستخدم

عندما تريد تصفح التسلسل الهرمي — على سبيل المثال، سرد المخططات (schemas) في مصدر بيانات، أو الجداول في مخطط، أو الأعمدة في جدول، أو الاختبارات في مجلد، أو المشاريع في الصفحة الرئيسية.

list_quick_tests

سرد الاختبارات السريعة (quick tests) المتاحة لجدول أو عمود.

المعامل	النوع	مطلوب	الوصف
object_type	enum	نعم	Table أو Column
object_id	integer	نعم	معرّف الجدول أو العمود
filter_by_quality_dimension	string	لا	التصفية حسب بُعد الجودة (مثل Completeness، Uniqueness)
filter_by_test_status	string	لا	التصفية حسب ما إذا كان الاختبار موجودًا مسبقًا
filter_by_search_text	string	لا	فلتر بحث حر بالنص

متى تُستخدم

عندما تريد الاطلاع على الاختبارات الجاهزة المتاحة لجدول أو عمود محدد، مع إمكانية التصفية حسب بُعد الجودة أو تغطية الاختبارات الحالية.

list_custom_metadata_options

سرد حقول البيانات الوصفية المخصصة (custom metadata) وخياراتها لكائن Validatar.

المعامل	النوع	مطلوب	الوصف
object_type	enum	نعم	نوع الكائن
object_id	integer	نعم	معرّف الكائن
only_return_populated	boolean	نعم	إرجاع الحقول التي تحتوي على قيم فقط
only_return_visible	boolean	نعم	إرجاع الحقول المرئية في الواجهة فقط
type_equals_filter	string	لا	التصفية حسب نوع الحقل
name_contains_filter	string	لا	التصفية حسب اسم الحقل
reference_key_contains_filter	string	لا	التصفية حسب مفتاح المرجع (reference key)

متى تُستخدم

عندما تريد معرفة حقول البيانات الوصفية المخصصة المتاحة لكائن ما والقيم التي تحملها حاليًا.

convert_url_to_key

تحويل عنوان URL لتطبيق Validatar إلى نوع كائن ومعرّف.

المعامل	النوع	مطلوب	الوصف
url	string	نعم	عنوان URL لتطبيق Validatar

متى تُستخدم

عندما يكون لديك عنوان URL من واجهة Validatar وتحتاج إلى تحديد نوع الكائن ومعرّفه لاستخدامه مع أدوات MCP الأخرى.

get_global_trust_score_settings

استرجاع تهيئة درجة الثقة العامة (global trust score).

المعامل	النوع	مطلوب	الوصف
output_sections	list	لا	الأقسام المراد تضمينها: QualityDimensions، SeverityLevels، ImpactRatings

متى تُستخدم

عندما تحتاج إلى فهم كيفية حساب درجات الثقة، وأبعاد الجودة المهيأة، ومستويات الخطورة وتقييمات التأثير المتاحة.

search_documentation_articles

البحث عبر جميع مقالات وثائق Validatar.

المعامل	النوع	مطلوب	الوصف
search_query	string	نعم	مصطلحات البحث المراد إيجادها

متى تُستخدم

عندما تريد إيجاد مقالات وثائق ذات صلة بكلمة مفتاحية أو موضوع.

search_documentation_assistive

طرح سؤال على مساعد وثائق Validatar.

المعامل	النوع	مطلوب	الوصف
prompt	string	نعم	سؤال بلغة طبيعية حول Validatar

متى تُستخدم

عندما يكون لديك سؤال عن طريقة عمل Validatar وتريد إجابة مُلخّصة مستمدة من الوثائق.

أدوات الكتابة (Write Tools)

تقوم هذه الأدوات بإنشاء أو تعديل أو تنفيذ عمليات في نسخة Validatar الخاصة بك. يتم تتبع جميع عمليات الكتابة كإجراءات ذكاء اصطناعي (AI Actions) ويمكن التراجع عنها.

create_standard_test

إنشاء اختبار قياسي (standard test) جديد في مشروع.

المعامل	النوع	مطلوب	الوصف
project_id	integer	نعم	المشروع الذي سيُنشأ فيه الاختبار
config	object	نعم	تهيئة الاختبار القياسي (تشمل الاسم، والمجلد، ومجموعات البيانات، وشروط النجاح، ومعاملات الاختبار)

متى تُستخدم

عندما تريد إنشاء اختبار منفرد يتحقق من حالة بيانات محددة باستعلامات مصدر وهدف معرّفة صراحة.

create_template_test

إنشاء اختبار قالب (template test) جديد في مشروع.

المعامل	النوع	مطلوب	الوصف
project_id	integer	نعم	المشروع الذي سيُنشأ فيه الاختبار
config	object	نعم	تهيئة اختبار القالب (تشمل الاسم، والمجلد، ومعايير اختيار البيانات الوصفية، والمتغيرات، ومنطق الاختبار)

متى تُستخدم

عندما تريد إنشاء تعريف اختبار قابل لإعادة الاستخدام يولّد تلقائيًا اختبارات فرعية بناءً على معايير اختيار البيانات الوصفية.

create_quick_test

إنشاء اختبار سريع لجدول أو عمود من قالب متاح.

المعامل	النوع	مطلوب	الوصف
object_type	enum	نعم	Table أو Column
object_id	integer	نعم	معرّف الجدول أو العمود
template_test_id	integer	نعم	معرّف قالب الاختبار السريع المراد استخدامه
variables	object	نعم	قيم المتغيرات المطلوبة للقالب
custom_fields	object	نعم	قيم الحقول المخصصة المراد تعيينها للاختبار الذي سيُنشأ

متى تُستخدم

عندما تريد إضافة تغطية اختبار بسرعة لجدول أو عمود باستخدام أحد قوالب الاختبار السريع المحددة مسبقًا.

create_data_source

إنشاء مصدر بيانات جديد.

المعامل	النوع	مطلوب	الوصف
config	object	نعم	تهيئة مصدر البيانات (تشمل الاسم، وتفاصيل الاتصال، والقالب، والإعدادات)

متى تُستخدم

عندما تريد تسجيل اتصال قاعدة بيانات جديد في Validatar لأغراض الاختبار والتحليل.

update_data_source

تحديث تهيئة مصدر بيانات موجود.

المعامل	النوع	مطلوب	الوصف
data_source_id	integer	نعم	معرّف مصدر البيانات المراد تحديثه
config	object	نعم	تهيئة مصدر البيانات المحدَّثة

متى تُستخدم

عندما تحتاج إلى تعديل تفاصيل الاتصال أو الإعدادات أو خصائص أخرى لمصدر بيانات موجود.

execute_standard_tests

تنفيذ اختبار قياسي واحد أو أكثر.

المعامل	النوع	مطلوب	الوصف
object_id_list	list of integers	نعم	قائمة معرّفات الاختبارات القياسية المراد تنفيذها (وليس معرّفات اختبارات القوالب)

متى تُستخدم

عندما تريد تشغيل اختبارات محددة ورؤية نتائجها. يمكن تنفيذ الاختبارات القياسية فقط (بما فيها الاختبارات الفرعية المتحققة من القوالب) بشكل مباشر.

execute_data_source_script

تنفيذ سكربت SQL أو Python مقابل مصدر بيانات.

المعامل	النوع	مطلوب	الوصف
data_source_id	integer	نعم	مصدر البيانات المراد التنفيذ عليه
script	string	نعم	سكربت SQL أو Python المراد تشغيله
timeout_seconds	integer	لا	الحد الأقصى لوقت التنفيذ (تُطبَّق القيمة الافتراضية إذا لم تُحدَّد)
max_rows	integer	لا	الحد الأقصى لعدد الصفوف المُرجَعة

متى تُستخدم

عندما تريد تشغيل استعلامات مخصصة لاستكشاف البيانات، أو التحقق من الافتراضات، أو استكشاف مشكلات نتائج الاختبارات.

update_custom_metadata

تحديث قيم حقول البيانات الوصفية المخصصة لكائن في Validatar.

المعامل	النوع	مطلوب	الوصف
object_type	enum	نعم	نوع الكائن المراد تحديثه
object_id	integer	نعم	معرّف الكائن
field_values	object	نعم	القيم المراد تعيينها، بالبنية {"field_name": {"values": ["value1", "value2"]}}

متى تُستخدم

عندما تريد وسم أو تصنيف الكائنات ببيانات وصفية مخصصة — مثل تعيين نطاقات البيانات أو الملاك أو مستويات الحساسية.

create_folder

إنشاء مجلد جديد في مشروع.

المعامل	النوع	مطلوب	الوصف
project_id	integer	نعم	المشروع الذي سيُنشأ فيه المجلد
parent_folder_id	integer	نعم	معرّف المجلد الأصل
name	string	نعم	اسم المجلد الجديد

متى تُستخدم

عندما تريد تنظيم الاختبارات ضمن بنية مجلدات داخل مشروع.

rename_folder

إعادة تسمية مجلد موجود.

المعامل	النوع	مطلوب	الوصف
project_id	integer	نعم	المشروع الذي يحتوي على المجلد
folder_id	integer	نعم	المجلد المراد إعادة تسميته
name	string	نعم	الاسم الجديد للمجلد

متى تُستخدم

عندما تريد تحديث الاسم المعروض لمجلد.

move_folder

نقل مجلد إلى أصل مختلف.

المعامل	النوع	مطلوب	الوصف
project_id	integer	نعم	المشروع الذي يحتوي على المجلد
folder_id	integer	نعم	المجلد المراد نقله
parent_folder_id	integer	نعم	معرّف المجلد الأصل الجديد

متى تُستخدم

عندما تريد إعادة تنظيم التسلسل الهرمي للمجلدات ضمن مشروع.

delete_folder

حذف مجلد من مشروع.

المعامل	النوع	مطلوب	الوصف
project_id	integer	نعم	المشروع الذي يحتوي على المجلد
folder_id	integer	نعم	المجلد المراد حذفه
delete_child_tests	boolean	نعم	هل يتم أيضًا حذف الاختبارات الموجودة داخل المجلد

متى تُستخدم

عندما تريد إزالة مجلد غير مستخدم. اضبط delete_child_tests على true لإزالة الاختبارات المتضمنة، أو false لنقلها إلى المجلد الأصل.

create_project

إنشاء مشروع جديد.

المعامل	النوع	مطلوب	الوصف
config	object	نعم	تهيئة المشروع (تشمل الاسم والإعدادات)

متى تُستخدم

عندما تريد إعداد مشروع جديد لتنظيم الاختبارات وتنفيذها.

update_project

تحديث تهيئة مشروع موجود.

المعامل	النوع	مطلوب	الوصف
config	object	نعم	تهيئة المشروع المحدَّثة

متى تُستخدم

عندما تحتاج إلى تعديل إعدادات أو خصائص المشروع.

revert_action

التراجع عن تغيير تم إجراؤه بواسطة إجراء ذكاء اصطناعي (AI Action) نُفِّذ سابقًا.

المعامل	النوع	مطلوب	الوصف
action_key	string	نعم	مفتاح إجراء التراجع الذي أعادته عملية الكتابة الأصلية
comment	string	نعم	تعليق يوضّح سبب التراجع عن الإجراء
reason	enum	نعم	سبب التراجع: AiDidNotDoWhatWasRequested، ChangeNoLongerDesired، Testing، أو Other

متى تُستخدم

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

أنواع الكائنات (Object Types)

تُستخدم أنواع الكائنات التالية عبر الأدوات التي تقبل معامل object_type:

نوع الكائن	الوصف
Home	نقطة الدخول الرئيسية
Catalog	كتالوج البيانات
DataSource	اتصال قاعدة بيانات مهيّأ
Schema	مخطط ضمن مصدر بيانات
Table	جدول ضمن مخطط
Column	عمود ضمن جدول
Project	مشروع اختبار
Folder	مجلد ضمن مشروع
Test	اختبار قياسي أو اختبار قالب
Job	مهمة تنفيذ اختبار
Report	تعريف تقرير
GlobalSettings	إعدادات النظام على مستوى النسخة
Marketplace	سوق Validatar (Marketplace)

صيغة قيم الحقول المخصصة

تقبل عدة أدوات قيم الحقول المخصصة أو تُرجعها. الصيغة ثابتة على النحو التالي:

{
  "field_name": {
    "values": ["value1", "value2"]
  },
  "another_field": {
    "values": ["single_value"]
  }
}

يقبل كل حقل قائمة من القيم — حتى الحقول أحادية القيمة تستخدم مصفوفة (array).

مرتبط

Connecting to the Validatar MCP Server — الإعداد والمصادقة.
Using the Validatar AI Chat Interface — تجربة الدردشة بالذكاء الاصطناعي داخل التطبيق.

السابقالاتصال بخادم Validatar MCP