Skip to main content
Glama

SFML 3.1.0 Dokumentations-MCP-Server (sfml3-ref)

License: MIT SFML Model Context Protocol TypeScript

Ein offizieller Model Context Protocol (MCP)-Server, der KI-Assistenten (Claude Desktop, Cursor, Claude Code, Cline usw.) direkten, offline Zugriff auf die vollständige SFML 3.1.0 C++-Referenzdokumentation bietet.


🌟 Funktionen

  • Saubere Markdown-API-Referenz: Doxygen-HTML-Dokumentation wird geparst und in formatiertes GitHub-Markdown mit syntax-hervorgehobenen C++-Codeblöcken bereinigt.

  • Vollständige C++20-Signaturen: Vollständige Methodenprototypen mit Spezifizierern ([[nodiscard]], constexpr, explicit, delete, Standardargumente).

  • Nach Modul kategorisiert: Alle 155+ Symbole sind über die 5 SFML-Module kategorisiert: System, Window, Graphics, Audio und Network.

  • Schnelle In-Memory-Suche: Sub-Millisekunden-Lookup über Symbolnamen, Memberfunktionen, Parameter und Beschreibungen.

  • Intelligente Aliase: Direkte Auflösung gängiger SFML-Typedefs und Helfer (z. B. Vector2f ➔ sf::Vector2<T>, IntRect ➔ sf::Rect<T>, seconds ➔ sf::Time).


Related MCP server: Garmin Documentation MCP Server

🛠️ MCP-Werkzeuge

Werkzeug

Parameter

Beschreibung

list_modules

keine

Listet die 5 primären SFML-3.1.0-Module mit Beschreibungen und Symbolanzahlen auf.

get_module_toc

module_name: string

Gibt das Inhaltsverzeichnis für ein Modul zurück (Klassen, Strukturen, Aufzählungen, Namespaces, Funktionen).

search_sfml_symbol

query: string

Durchsucht Symbole und Membermethoden nach einem bestimmten Begriff (z. B. Sprite, setTexture, pollEvent).

get_sfml_doc

symbol_name: string

Gibt vollständige Markdown-Dokumentation und C++-Prototypen für ein bestimmtes Symbol zurück (z. B. sf::Sprite, sf::Vector2, sf::Dns).


🚀 Erste Schritte

Voraussetzungen

  • Node.js (v18.0.0 oder höher empfohlen)

  • npm

Installation und Build

# 1. Clone the repository
git clone https://github.com/Floxius/sfml3-ref.git
cd sfml3-ref

# 2. Install dependencies
npm install

# 3. Build the TypeScript server
npm run build

Hinweis: Das Repository enthält bereits die vorgefertigte index.json (~1 MB), daher müssen Sie die rohen SFML-Doxygen-HTML-Dateien nicht herunterladen, es sei denn, Sie möchten das Indizierungsskript erneut ausführen.


🖥️ Client-Konfiguration

1. Claude Desktop

Fügen Sie den Server zu Ihrer Claude Desktop-Konfigurationsdatei hinzu:

  • Windows: %APPDATA%\Claude\claude_desktop_config.json

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  • Linux: ~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "sfml3-ref": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/sfml3-ref/dist/src/index.js"
      ]
    }
  }
}

(Unter Windows verwenden Sie Schrägstriche oder doppelte Backslashes, z. B. C:/Users/<username>/Documents/sfml3-ref/dist/src/index.js)

Alternative: Direkt mit tsx ausführen (kein Build-Schritt erforderlich)

{
  "mcpServers": {
    "sfml3-ref": {
      "command": "npx",
      "args": [
        "-y",
        "tsx",
        "/ABSOLUTE/PATH/TO/sfml3-ref/src/index.ts"
      ]
    }
  }
}

2. Cursor / Cline / Andere MCP-Clients

Fügen Sie einen STDIO-MCP-Server hinzu mit:

  • Befehl: node

  • Argumente: ["/path/to/sfml3-ref/dist/src/index.js"]


📖 Verwendungsbeispiele

Sobald Sie in Claude oder Ihrem MCP-Client verbunden sind, können Sie Abfragen wie die folgenden stellen:

  • "Listen Sie alle in SFML 3.1 verfügbaren Module auf."

  • "Zeigen Sie mir alle Klassen und Funktionen im SFML Graphics-Modul."

  • "Wie lautet die Konstruktorsignatur für sf::Sprite in SFML 3?"

  • "Wie frage ich DNS-Einträge mit sf::Dns in SFML 3.1 ab?"

  • "Suchen Sie nach Methoden zur Ereignisbehandlung in SFML 3."


🔄 Index neu erstellen (Optional)

Wenn Sie index.json von Grund auf neu generieren möchten:

  1. Laden Sie die SFML-3.1.0-Doxygen-HTML-Dokumentation von der SFML-Website herunter.

  2. Extrahieren Sie die HTML-Dateien in einen Ordner namens SFML-3.1.0 im Repository-Stammverzeichnis.

  3. Führen Sie das Indizierungsskript aus:

    npm run build:index

📄 Lizenz

  • Servercode: Lizenziert unter der MIT-Lizenz.

  • SFML-Dokumentation & -Bibliothek: Copyright © Laurent Gomila & SFML-Team. SFML ist unter den Bedingungen der zlib/png-Lizenz lizenziert.

Related MCP Connectors

Related MCP Servers