owasp_cheatsheets_mcp_server

Ein minimal mit dem Model Context Protocol (MCP) kompatibler Server, der die OWASP Cheat Sheets bereitstellt.

Der Server verwendet FastAPI , um eine einfache HTTP-API bereitzustellen, die den Inhalt der Spickzettel aus der OWASP Cheat Sheet Series zurückgibt.

Voraussetzungen

• Python 3.8 oder neuer

• Git (zum Klonen des Spickzettel-Repositorys beim ersten Ausführen)

Related MCP server: vuln-nist-mcp-server

Verwendung

1. Installationsanforderungen:

   pip install -r requirements.txt

2. (Optional) Legen Sie CHEATSHEETS_DIR fest, wenn Sie bereits eine lokale Kopie der Spickzettel haben:

   export CHEATSHEETS_DIR=/path/to/CheatSheetSeries/cheatsheets

3. Führen Sie den Server mit uvicorn aus:

   uvicorn server.app:app --reload

4. Wenn CHEATSHEETS_DIR nicht festgelegt ist, klont der Server das Spickzettel-Repository beim ersten Start (erfordert Netzwerkzugriff).

Endpunkte

• GET /health – Grundlegender Gesundheitscheck.

• GET /cheatsheets – Listet die verfügbaren Spickzetteldateien auf.

• GET /cheatsheets/{name} – Ruft einen bestimmten Spickzettel ab.

• GET /search?q=term – Durchsucht Spickzettel nach einem Begriff und gibt passende Dateinamen zurück.

Wird in der Produktion ausgeführt

Verwenden Sie uvicorn beim Bereitstellen mit explizitem Host und Port:

uvicorn server.app:app --host 0.0.0.0 --port 8000

Erwägen Sie für eine echte Bereitstellung einen Prozessmanager wie systemd oder die Ausführung hinter einem Reverse-Proxy.

Beitragen

Pull Requests sind willkommen. Tests können mit pytest in einem Verzeichnis tests/ hinzugefügt werden.

Diese Implementierung ist ein vereinfachtes Beispiel eines MCP-Servers und deckt möglicherweise nicht die gesamte Spezifikation ab.