Slither MCP Server

خادم بروتوكول سياق النموذج (MCP) يوفر قدرات تحليل ثابت للعقود الذكية بلغة Solidity باستخدام Slither.

نظرة عامة

يغلف خادم MCP هذا وظائف التحليل الثابت لـ Slither، مما يجعلها قابلة للوصول عبر بروتوكول سياق النموذج. يمكنه تحليل مشاريع Solidity (Foundry، Hardhat، إلخ) وإنشاء بيانات وصفية شاملة حول العقود والوظائف والتسلسلات الهرمية للوراثة والمزيد.

يمكنك أيضًا استخدام Slither MCP كواجهة برمجة تطبيقات Slither سهلة الاستخدام لحالات استخدام أخرى.

الميزات

• التخزين المؤقت: يتم تخزين عمليات تشغيل Slither مؤقتًا في {$PROJECT_PATH}/artifacts/project_facts.json للتحميل اللاحق الأسرع
• أدوات MCP: استعلام معلومات العقد والوظائف من خلال أدوات MCP
• تحليل الأمان: تشغيل كاشفات Slither والوصول إلى النتائج مع التصفية
• تحليل شامل: يستخرج معلومات مفصلة حول:
  • بيانات العقد الوصفية (إشارات مجردة، واجهة، مكتبة)
  • تواقيع الوظائف والمعدلات
  • تسلسلات الوراثة
  • علاقات استدعاء الوظائف (داخلية، خارجية، استدعاءات مكتبة)
  • ثغرات أمنية ومشكلات جودة الكود
  • مواقع الكود المصدري

بينما هذا إصدار v1.0، فإننا نتوقع تغييرات في API مع تلقي المزيد من التعليقات.

التثبيت

يستخدم هذا المشروع UV لإدارة الحزم:

# Install dependencies
uv sync

# Or install in development mode
uv pip install -e .

الاستخدام

الاستخدام الأساسي

ابدأ خادم Slither MCP:

uv run slither-mcp

تقبل جميع الأدوات معلمة path التي تحدد مشروع Solidity المراد تحليله. يتم تخزين المشاريع مؤقتًا تلقائيًا في <path>/artifacts/project_facts.json للاستعلامات اللاحقة الأسرع.

الاستخدام في Claude Code

claude mcp add --transport stdio --scope user slither -- uvx --from git+https://github.com/trailofbits/slither-mcp slither-mcp

الاستخدام في Cursor

تأكد من أن uvx موجود في مسار Cursor باستخدام sudo ln -s ~/.local/bin/uvx /usr/local/bin/uvx

في ملف ~/.cursor/mcp.json الخاص بك:

{
  "mcpServers": {
    "slither-mcp": {
      "command": "uvx --from git+https://github.com/trailofbits/slither-mcp slither-mcp",
    }
  }
}

المقاييس والخصوصية

يتضمن Slither MCP مقاييس اختيارية للمساعدة في تحسين الموثوقية من خلال إعلامنا بعدد مرات استخدام LLMs لكل أداة ومعدل نجاح استدعائها. المقاييس ممكّنة افتراضيًا ولكن يمكن تعطيلها بشكل دائم.

ما نجمعه

• أحداث استدعاء الأداة (الأدوات المستخدمة)
• حالة النجاح/الفشل

لا نجمع: معاملات استدعاء الأداة، تفاصيل العقد، أسماء الوظائف، أو أي معلومات خاصة بالمشروع.

تعطيل المقاييس

للإلغاء الدائم:

uv run slither-mcp --disable-metrics

للتفاصيل الكاملة، راجع METRICS.md.

أدوات MCP

يعرض الخادم أدوات للاستعلام عن معلومات العقد والوظائف. تقبل جميع الأدوات معلمة path تحدد دليل مشروع Solidity المراد تحليله.

أدوات الاستعلام

1. list_contracts - قائمة العقود مع مرشحات

يتطلب: path (دليل المشروع) تصفية العقود حسب النوع (ملموس، مجرد، واجهة، مكتبة) أو نمط المسار.

2. get_contract - الحصول على معلومات مفصلة عن العقد

استرجاع بيانات العقد الوصفية الكاملة بما في ذلك الوظائف والوراثة والإشارات.

3. get_contract_source - الحصول على كود مصدر العقد

يعيد الكود المصدري الكامل لملف Solidity الذي يحتوي على العقد المحدد.

4. get_function_source - الحصول على كود مصدر الوظيفة

يعيد الكود المصدري لوظيفة محددة مع أرقام الأسطر. مفيد للتحليل المركز.

5. list_functions - قائمة الوظائف مع مرشحات

تصفية الوظائف حسب العقد أو الرؤية أو المعدلات.

6. function_callees - الحصول على علاقات استدعاء الوظائف

يعيد المُستدعَيات الداخلية والخارجية والمكتبة لوظيفة، بما في ذلك كشف الاستدعاء منخفض المستوى.

7. function_callers - الحصول على الوظائف التي تستدعي وظيفة هدف

يعيد جميع الوظائف التي تستدعي وظيفة الهدف المحددة، مجمعة حسب نوع الاستدعاء (داخلي، خارجي، مكتبة). هذا هو عكس function_callees.

8. get_inherited_contracts - الحصول على وراثة العقد

يعيد شجرة تكرارية لجميع العقود التي يرث منها العقد (آباء وأجداد).

9. get_derived_contracts - الحصول على العقود التي ترث من هذا العقد

يعيد شجرة تكرارية لجميع العقود التي ترث من عقد (أبناء وأحفاد).

10. list_function_implementations - العثور على تطبيقات الوظائف

العثور على جميع تطبيقات توقيع وظيفة عبر العقود.

11. list_detectors - قائمة كاشفات Slither المتاحة

يعيد بيانات وصفية حول كاشفات Slither بما في ذلك الأسماء والأوصاف ومستويات التأثير وتصنيفات الثقة. يدعم التصفية حسب الاسم أو الوصف.

12. run_detectors - الحصول على نتائج الكاشف مع التصفية

يعيد نتائج الكاشف المخزنة مؤقتًا. تصفية حسب أسماء الكاشف أو مستوى التأثير (عالٍ، متوسط، منخفض، إعلامي) أو مستوى الثقة (عالٍ، متوسط، منخفض).

تعيد جميع الأدوات استجابات تحتوي على قيمة منطقية success وحقول بيانات أو error_message. راجع تنفيذات الأدوات الفردية في slither_mcp/tools/ للحصول على مخططات مفصلة والاستخدام.

استخدام العميل

تتضمن حزمة slither-mcp عميل Python مكتوب (SlitherMCPClient) للتفاعل برمجيًا مع خادم Slither MCP. هذا مفيد لبناء أدوات أو نصوص أو وكلاء يحتاجون إلى الاستعلام عن مشاريع Solidity.

يوفر العميل:

• طرق آمنة الكتابة لجميع أدوات MCP
• تسلسل/إلغاء تسلسل تلقائي لنماذج Pydantic
• طرق مساعدة للأنماط الشائعة
• مغلفات أدوات لتكامل وكيل pydantic-ai

للحصول على أمثلة استخدام مفصلة ووثائق، راجع CLIENT_USAGE.md.

المتطلبات

• بايثون 3.11+
• إعداد مترجم Solidity (Foundry، Hardhat، أو ما شابه)
• Slither وتبعياته

التطوير

خطافات ما قبل الالتزام

قم بتثبيت خطافات ما قبل الالتزام لتشغيل التحليل اللغوي قبل الالتزامات:

pre-commit install

تشغيل الاختبارات

uv run pytest