Slither MCP Server

Ein Model Context Protocol (MCP)-Server, der statische Analysefunktionen für Smart Contracts in Solidity mithilfe von Slither bereitstellt.

Übersicht

Dieser MCP-Server kapselt die statische Analysefunktionalität von Slither und macht sie über das Model Context Protocol zugänglich. Er kann Solidity-Projekte (Foundry, Hardhat usw.) analysieren und umfassende Metadaten zu Contracts, Funktionen, Vererbungshierarchien und mehr erzeugen.

Sie können Slither MCP auch als einfach zu verwendende Slither-API für andere Anwendungsfälle nutzen.

Funktionen

• Caching: Slither-Läufe werden für schnellere anschließende Ladezeiten in {$PROJECT_PATH}/artifacts/project_facts.json zwischengespeichert
• MCP-Tools: Fragen Sie Contract- und Funktionsinformationen über MCP-Tools ab
• Sicherheitsanalyse: Führen Sie Slither-Detektoren aus und greifen Sie mit Filterung auf Ergebnisse zu
• Umfassende Analyse: Extrahiert detaillierte Informationen über:
  • Contract-Metadaten (Flags für abstract, interface, library)
  • Funktionssignaturen und Modifier
  • Vererbungshierarchien
  • Funktionsaufrufbeziehungen (interne, externe und Library-Aufrufe)
  • Sicherheitslücken und Probleme der Codequalität
  • Quellcodestellen

Auch wenn dies eine v1.0-Veröffentlichung ist, erwarten wir API-Änderungen, sobald wir mehr Feedback erhalten.

Installation

Dieses Projekt verwendet UV für die Paketverwaltung:

# Install dependencies
uv sync

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

Verwendung

Grundlegende Verwendung

Starten Sie den Slither-MCP-Server:

uv run slither-mcp

Alle Tools akzeptieren einen Parameter path, der angibt, welches Solidity-Projekt analysiert werden soll. Projekte werden automatisch in <path>/artifacts/project_facts.json zwischengespeichert, um nachfolgende Abfragen zu beschleunigen.

Verwendung in Claude Code

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

Verwendung in Cursor

Stellen Sie sicher, dass sich uvx mit sudo ln -s ~/.local/bin/uvx /usr/local/bin/uvx in Ihrem Cursor-Pfad befindet.

In Ihrer Datei ~/.cursor/mcp.json:

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

Metriken und Datenschutz

Slither MCP enthält Opt-out-Metriken, die uns helfen, die Zuverlässigkeit zu verbessern, indem sie uns zeigen, wie häufig LLMs welches Tool verwenden und wie hoch deren Erfolgsquote bei Aufrufen ist. Metriken sind standardmäßig aktiviert, können aber dauerhaft deaktiviert werden.

Was wir erfassen

• Tool-Aufrufereignisse (welche Tools verwendet werden)
• Erfolgs-/Fehlerstatus

Wir erfassen nicht: Tool-Aufrufparameter, Contract-Details, Funktionsnamen oder projektspezifische Informationen.

Deaktivieren der Metriken

So deaktivieren Sie die Metriken dauerhaft:

uv run slither-mcp --disable-metrics

Ausführliche Details finden Sie in METRICS.md.

MCP-Tools

Der Server stellt Tools zum Abfragen von Contract- und Funktionsinformationen bereit. Alle Tools akzeptieren einen Parameter path, der das zu analysierende Solidity-Projektverzeichnis angibt.

Abfragetools

1. list_contracts - Contracts mit Filtern auflisten

Erfordert: path (Projektverzeichnis) Filtert Contracts nach Typ (concrete, abstract, interface, library) oder Pfadmuster.

2. get_contract - Detaillierte Contract-Informationen abrufen

Ruft vollständige Contract-Metadaten einschließlich Funktionen, Vererbung und Flags ab.

3. get_contract_source - Contract-Quellcode abrufen

Gibt den vollständigen Quellcode der Solidity-Datei zurück, die den angegebenen Contract enthält.

4. get_function_source - Funktionsquellcode abrufen

Gibt den Quellcode einer bestimmten Funktion mit Zeilennummern zurück. Nützlich für gezielte Analysen.

5. list_functions - Funktionen mit Filtern auflisten

Filtert Funktionen nach Contract, Sichtbarkeit oder Modifiern.

6. function_callees - Funktionsaufrufbeziehungen abrufen

Gibt interne, externe und Library-Callees einer Funktion zurück, einschließlich der Erkennung von Low-Level-Aufrufen.

7. function_callers - Funktionen abrufen, die eine Zielfunktion aufrufen

Gibt alle Funktionen zurück, die die angegebene Zielfunktion aufrufen, gruppiert nach Aufruftyp (internal, external, library). Dies ist die Umkehrung von function_callees.

8. get_inherited_contracts - Contract-Vererbung abrufen

Gibt einen rekursiven Baum aller Contracts zurück, von denen ein Contract erbt (Eltern und Vorfahren).

9. get_derived_contracts - Contracts abrufen, die von diesem erben

Gibt einen rekursiven Baum aller Contracts zurück, die von einem Contract erben (Kinder und Nachfahren).

10. list_function_implementations - Funktionsimplementierungen finden

Findet alle Implementierungen einer Funktionssignatur über Contracts hinweg.

11. list_detectors - Verfügbare Slither-Detektoren auflisten

Gibt Metadaten zu Slither-Detektoren zurück, einschließlich Namen, Beschreibungen, Auswirkungsstufen und Konfidenzratings. Unterstützt das Filtern nach Name oder Beschreibung.

12. run_detectors - Detektorergebnisse mit Filterung abrufen

Gibt zwischengespeicherte Detektorergebnisse zurück. Filtern Sie nach Detektornamen, Auswirkungsstufe (High, Medium, Low, Informational) oder Konfidenzstufe (High, Medium, Low).

Alle Tools geben Antworten mit einem booleschen Wert success und entweder Datenfeldern oder einer error_message zurück. Detaillierte Schemata und Verwendung finden Sie in den jeweiligen Tool-Implementierungen unter slither_mcp/tools/.

Client-Verwendung

Das Paket slither-mcp enthält einen typisierten Python-Client (SlitherMCPClient) für die programmatische Interaktion mit dem Slither-MCP-Server. Dies ist nützlich für die Erstellung von Tools, Skripte oder Agents, die Solidity-Projekte abfragen müssen.

Der Client bietet:

• Typsichere Methoden für alle MCP-Tools
• Automatische Serialisierung/Deserialisierung von Pydantic-Modellen
• Hilfsmethoden für gängige Muster
• Tool-Wrapper für die Integration von pydantic-ai-Agents

Ausführliche Verwendungsbeispiele und Dokumentation finden Sie in CLIENT_USAGE.md.

Voraussetzungen

• Python 3.11+
• Solidity-Compiler-Setup (Foundry, Hardhat oder Ähnliches)
• Slither und seine Abhängigkeiten

Entwicklung

Pre-Commit-Hooks

Installieren Sie Pre-Commit-Hooks, um vor Commits Linting auszuführen:

pre-commit install

Ausführen der Tests

uv run pytest