Zum Hauptinhalt springen

MCP Server

In ChatGPT öffnen

Der webforJ Model Context Protocol (MCP) Server bietet KI-Assistenten direkten Zugang zu offizieller webforJ-Dokumentation, verifizierten Codebeispielen und frameworkspezifischen Mustern, sodass Antworten mit genaueren Antworten und automatisierter Projektgenerierung speziell für die webforJ-Entwicklung möglich sind.

Was ist ein MCP?​

Das Model Context Protocol ist ein offener Standard, der es KI-Assistenten ermöglicht, mit externen Tools und Dokumentationen zu verbinden. Der webforJ MCP-Server implementiert dieses Protokoll, um Folgendes bereitzustellen:

  • Wissenssuche - Natürliche Sprache Suche in der webforJ-Dokumentation, Codebeispielen und Mustern
  • Projektgenerierung - Erstellen von webforJ-Anwendungen aus offiziellen Vorlagen mit ordnungsgemäßer Struktur
  • Theme-Erstellung - Generierung barrierefreier CSS-Themen gemäß den webforJ-Designmustern

Warum MCP verwenden?​

Während KI-Coding-Assistenten darin glänzen, grundlegende Fragen zu beantworten, haben sie Schwierigkeiten mit komplexen, webforJ-spezifischen Anfragen, die mehrere Dokumentationsabschnitte umfassen. Ohne direkten Zugang zu offiziellen Quellen können sie:

  • Methoden generieren, die es in webforJ nicht gibt
  • Veraltete oder falsche API-Muster referenzieren
  • Code bereitstellen, der nicht übersetzt werden kann
  • Die webforJ-Syntax mit anderen Java-Frameworks verwechseln
  • webforJ-spezifische Muster missverstehen

Mit der MCP-Integration sind KI-Antworten an tatsächliche webforJ-Dokumentation, Codebeispiele und Framework-Muster verankert, was überprüfbare Antworten mit direkten Links zu offiziellen Quellen für eine tiefere Erkundung bietet.

KI kann immer noch Fehler machen

Obwohl MCP die Genauigkeit erheblich verbessert, indem es Zugang zu offiziellen webforJ-Ressourcen bietet, garantiert es keine perfekte Codegenerierung. KI-Assistenten können in komplexen Szenarien weiterhin Fehler machen. Überprüfen Sie stets den generierten Code und testen Sie gründlich, bevor Sie ihn in der Produktion verwenden.

Installation​

Der webforJ MCP-Server wird unter https://mcp.webforj.com mit zwei Endpunkten gehostet:

  • MCP-Endpunkt (/mcp) - Für Claude, VS Code, Cursor
  • SSE-Endpunkt (/sse) - Für Legacy-Clients

Verwenden Sie den Claude-CLI-Befehl, um den Server zu registrieren:

claude mcp add webforj-mcp https://mcp.webforj.com/mcp -t http -s user

Dies konfiguriert den MCP-Server automatisch in Ihrer Claude-Code-Umgebung.

Verfügbare Werkzeuge​

Werkzeuge sind spezialisierte Funktionen, die der MCP-Server KI-Assistenten bereitstellt. Wenn Sie eine Frage stellen oder eine Anfrage machen, kann die KI diese Werkzeuge aufrufen, um Dokumentation zu durchsuchen, Projekte zu generieren oder Themen zu erstellen. Jedes Werkzeug akzeptiert spezifische Parameter und gibt strukturierte Daten zurück, die der KI helfen, genaue, kontextbezogene Unterstützung zu bieten.

Dieses Werkzeug bietet semantische Suchfunktionen über das gesamte webforJ-Dokumentations-Ökosystem. Es versteht den Kontext und Beziehungen zwischen verschiedenen Framework-Konzepten und gibt relevante Dokumentationsabschnitte, API-Referenzen und funktionierende Codebeispiele zurück.

Beispielabfragen:

"Durchsuche die webforJ-Dokumentation nach Button-Komponenten mit Icon-Beispielen"

"Finde webforJ-Formularvalidierungsmuster in der neuesten Dokumentation"

"Zeig mir die aktuelle webforJ-Routing-Konfiguration mit der @Route-Anmerkung"

"Durchsuche die webforJ-Dokumente nach FlexLayout-Responsive-Designmustern"

"Finde die Integration von webforJ-Webkomponenten in der offiziellen Dokumentation"

Erstellen Sie vollständige webforJ-Anwendungen mithilfe offizieller Maven-Archetypen. Das Werkzeug erstellt ein standardisiertes Projektverzeichnislayout und umfasst Starter-Code basierend auf der gewählten Vorlage. Generierte Projekte enthalten ein sofort einsatzbereites Build-System, Ressourcenordner und Konfigurationsdateien für die sofortige Entwicklung und Bereitstellung.

Beispielaufforderungen:

"Erstelle ein webforJ-Projekt namens CustomerPortal mit dem hello-world-Archetyp"

"Generiere ein webforJ Spring Boot-Projekt mit einem Tab-Layout namens Dashboard"

"Erstelle eine neue webforJ-App mit dem Sidemenu-Archetyp für das AdminPanel-Projekt"

"Generiere ein leeres webforJ-Projekt namens TestApp mit der groupId com.example"

"Erstelle ein webforJ-Projekt InventorySystem mit dem Sidemenu-Archetyp und Spring Boot"

Bei der Verwendung dieses Werkzeugs können Sie aus mehreren Projektvorlagen auswählen:

Archetypen (Projektvorlagen):

  • hello-world - Grundlegende App mit Beispielkomponenten, um die Funktionen von webforJ zu demonstrieren
  • blank - Minimale Projektstruktur zum Starten von Grund auf
  • tabs - Vorgefertigte, registerkartenbasierte Benutzeroberflächenlayout für Anwendungen mit mehreren Ansichten
  • sidemenu - Layout mit seitlicher Navigationsleiste für Administrationspanels oder Dashboards

Flavors (Framework-Integration):

  • webforj - Standard-webforJ-App
  • webforj-spring - webforj, integriert mit Spring Boot für Dependency Injection und Unternehmensfunktionen
Verfügbare Archetypen

webforJ kommt mit mehreren vordefinierten Archetypen, um Ihnen einen schnellen Start zu ermöglichen. Für eine vollständige Liste der verfügbaren Archetypen siehe den Archetypen-Katalog.

Generiert webforJ-Themkonfigurationen mit DWC HueCraft. Das Werkzeug erstellt vollständige CSS-Kategorieneigenschaften mit primären, sekundären, Erfolgs-, Warn-, Gefahren- und neutralen Farbvarianten.

Beispielanfragen:

"Generiere ein webforJ-Thema mit HSL 220, 70, 50 als Hauptfarbe für unsere Unternehmensmarke"

"Erstelle ein barrierefreies webforJ-Thema namens 'ocean' mit der Hauptfarbe #0066CC"

"Generiere ein webforJ-Thema mit unserer Markenfarbe #FF5733"

"Erstelle ein webforJ-Thema mit HSL 30, 100, 50, das 'sunset' für unsere App genannt wird"

"Generiere ein barrierefreies webforJ-Thema mit der Hauptfarbe RGB 44, 123, 229"

Verfügbare Aufforderungen​

Aufforderungen sind vorkonfigurierte KI-Anweisungen, die mehrere Werkzeuge und Arbeitsabläufe für häufige Aufgaben kombinieren. Sie führen die KI durch spezifische Schritte und Parameter, um zuverlässige, wiederholbare Ergebnisse für jeden unterstützten Arbeitsablauf zu liefern.

Argumente:

  • appName (erforderlich) - Anwendungsname (z.B. MyApp, TodoList, Dashboard)
  • archetype (erforderlich) - Wählen Sie aus: blank, hello-world, tabs, sidemenu
  • runServer (optional) - Den Entwicklungsserver automatisch ausführen (ja/nein)

Argumente:

  • primaryColor (erforderlich) - Farbe im Hex-Format (#FF5733), rgb (255,87,51) oder hsl (9,100,60)

Die Aufforderung konfiguriert die KI dazu:

  1. Umfassend in der Wissensdatenbank zu suchen
  2. Vollständigen, produktionsbereiten Code zu schreiben
  3. Das Projekt mit mvn compile zu kompilieren, um sicherzustellen, dass es keine Build-Fehler gibt
  4. Fehler iterativ zu beheben, bis alles funktioniert

Wie man Aufforderungen verwendet​

  1. Geben Sie / im Chat ein, um verfügbare Aufforderungen zu sehen
  2. Wählen Sie eine Aufforderung aus dem Dropdown-Menü aus
  3. Füllen Sie die erforderlichen Parameter aus, wenn Sie dazu aufgefordert werden

Best Practices​

Um die genauesten und aktuellsten webforJ-Hilfen zu erhalten, befolgen Sie diese Richtlinien, um die Funktionen des MCP-Servers voll auszuschöpfen.

Sicherstellen der Nutzung des MCP-Servers​

KI-Modelle könnten den MCP-Server überspringen, wenn sie glauben, sie wüssten bereits die Antwort. Um sicherzustellen, dass der MCP-Server tatsächlich verwendet wird:

  • Seien Sie explizit zu webforJ: Erwähnen Sie immer "webforJ" in Ihrer Anfrage, um frameworkspezifische Suchen auszulösen
  • Fordern Sie aktuelle Informationen an: Fügen Sie Phrasen wie "neueste webforJ-Dokumentation" oder "aktuelle webforJ-Muster" hinzu
  • Fragen Sie nach verifizierten Beispielen: Fordern Sie "funktionierende webforJ-Codebeispiele" an, um die Dokumentationssuche zu erzwingen
  • Referenzieren Sie spezifische Versionen: Erwähnen Sie Ihre webforJ-Version (z.B. "webforJ 25.02"), um genaue Ergebnisse zu erhalten

Schreiben spezifischer Aufforderungen​

Gute Beispiele:

"Durchsuche die webforJ-Dokumentation nach Button-Komponenten-Eventhandling mit Beispielen"

"Erstelle ein webforJ-Projekt namens InventorySystem mit dem Sidemenu-Archetyp und Spring Boot"

"Generiere ein webforJ-Thema mit HSL 220, 70, 50 als Hauptfarbe für die Unternehmensmarke"

Schlechte Beispiele:

"Wie funktionieren Buttons"

"Mach eine App"

"Mach es blau"

Erzwingen der Verwendung von MCP-Tool​

Wenn die KI allgemeine Antworten ohne Nutzung des MCP-Servers gibt:

  1. Explizit anfordern: "Verwenden Sie den webforJ MCP-Server, um nach [query] zu suchen"
  2. Nach Dokumentationsreferenzen fragen: "Finde in der webforJ-Dokumentation heraus, wie man [query]"
  3. Überprüfungen anfordern: "Überprüfen Sie diese Lösung anhand der webforJ-Dokumentation"
  4. Framework-spezifisch sein: Fügen Sie immer "webforJ" in Ihre Anfragen ein

Anpassung von KI​

Konfigurieren Sie Ihre KI-Assistenten so, dass sie den MCP-Server automatisch verwenden und die besten Praktiken von webforJ befolgen. Fügen Sie projektspezifische Anweisungen hinzu, damit Ihre KI-Assistenten den MCP-Server stets verwenden, die Dokumentationsstandards von webforJ befolgen und genaue, aktuelle Antworten liefern, die den Anforderungen Ihres Teams entsprechen.

Projektkonfigurationsdateien​

  • Für VS Code und Copilot erstellen Sie .github/copilot-instructions.md
  • Für Claude Code erstellen Sie CLAUDE.md im Projektstammverzeichnis

Fügen Sie Folgendes zu der erstellten Markdown-Datei hinzu:

## Verwenden Sie den webforJ MCP-Server, um alle Fragen zu webforJ zu beantworten

- Rufen Sie immer das Werkzeug "webforj-knowledge-base" auf, um relevante Dokumente zu suchen
- Überprüfen Sie alle API-Signaturen anhand der offiziellen Dokumentation
- Nehmen Sie niemals an, dass Methoden- oder Parameternamen existieren, ohne dies zu überprüfen

Überprüfen Sie immer, ob der Code mit `mvn compile` übersetzt wird, bevor Sie Vorschläge machen.

FAQ​

Die meisten KI-Assistenten benötigen explizite Anweisungen, um MCP-Server zu verwenden. Konfigurieren Sie Ihren KI-Client mit den Anweisungen aus dem Abschnitt KI-Anpassung. Ohne diese Anweisungen verwenden KI-Assistenten möglicherweise standardmäßig ihre Trainingsdaten, anstatt den MCP-Server zu befragen.

Schnelle Lösung: Fügen Sie "verwendet den webforJ MCP" in Ihre Aufforderung ein oder erstellen Sie die entsprechende Konfigurationsdatei (.github/copilot-instructions.md oder CLAUDE.md).

Verwenden Sie den MCP-Inspektor, um Verbindungen zu debuggen:

npx @modelcontextprotocol/inspector

Warten Sie auf die Nachricht: 🔍 MCP Inspector ist aktiv und läuft unter http://127.0.0.1:6274 (Port kann variieren)

Dann im Inspektor:

  1. Geben Sie die MCP-Server-URL ein: https://mcp.webforj.com/mcp
  2. Klicken Sie auf "Verbinden", um die Verbindung herzustellen
  3. Sehen Sie sich verfügbare Werkzeuge an und testen Sie Anfragen
  4. Überwachen Sie die Anforderungs-/Antwortprotokolle zur Fehlersuche

Der webforJ MCP-Server bietet zwei Endpunkte:

  • MCP-Endpunkt (/mcp) - Modernes Protokoll für Claude, VS Code, Cursor
  • SSE-Endpunkt (/sse) - Server-Sent Events für Legacy-Clients wie Windsurf

Die meisten Benutzer sollten den MCP-Endpunkt verwenden. Verwenden Sie SSE nur, wenn Ihr Client das Standard-MCP-Protokoll nicht unterstützt.

Ja, aber es wird nicht empfohlen. Ohne Konfigurationsdateien müssen Sie die KI manuell auffordern, den MCP-Server in jeder Konversation zu verwenden. Konfigurationsdateien instruieren die KI automatisch, den MCP-Server für jede Interaktion zu verwenden, sodass Sie nicht jedes Mal Anweisungen wiederholen müssen.

Manuelle Vorgehensweise: Beginnen Sie Aufforderungen mit: "Verwenden Sie den webforJ MCP-Server, um..."

Alternativ: Verwenden Sie vorkonfigurierte Aufforderungen Der MCP-Server bietet Aufforderungen, die ohne Konfigurationsdateien funktionieren:

  • /create-app - Neue webforJ-Anwendungen generieren
  • /create-theme - Barrierefreie CSS-Themen erstellen
  • /search-webforj - Erweiterte Dokumentationssuche

Siehe Verfügbare Aufforderungen für Details.

Probleme melden: webforJ MCP-Issue-Vorlage

Häufige Probleme, die gemeldet werden sollten:

  • Veraltete Dokumentation in den Suchergebnissen
  • Fehlende API-Methoden oder -Komponenten
  • Falsche Codebeispiele
  • Werkzeugausführungsfehler

Geben Sie Ihre Anfrage, das erwartete Ergebnis und das tatsächliche Ergebnis an, wenn Sie Probleme melden.