IBM wxflows MCP Server

Verwendung der watsonx.ai Flows Engine mit dem Model Context Protocol (MCP)

Hier ist eine Schritt-für-Schritt-Anleitung zum Einrichten und Bereitstellen eines Projekts mit wxflows, einschließlich der Installation notwendiger Werkzeuge, der Bereitstellung der App und der lokalen Ausführung.

Dieses Beispiel besteht aus den folgenden Teilen:

• MCP TypeScript SDK (MCP-Server)
• wxflows SDK (Werkzeuge)

Sie können jeden der unterstützten MCP-Clients verwenden.

Diese Anleitung führt Sie durch die Installation der wxflows CLI, die Initialisierung und Bereitstellung eines Projekts und die lokale Ausführung der Anwendung. Wir verwenden google_books- und wikipedia-Werkzeuge als Beispiele für Werkzeugaufrufe mit wxflows.

Bevor Sie beginnen

Klonen Sie dieses Repository und öffnen Sie das richtige Verzeichnis:

git clone https://github.com/IBM/wxflows.git
cd examples/mcp/javascript

Schritt 1: wxflows einrichten

Bevor Sie mit der Erstellung von KI-Anwendungen mit der watsonx.ai Flows Engine beginnen können:

1. Registrieren Sie sich für ein kostenloses Konto
2. Laden Sie die Node.js CLI herunter und installieren Sie sie
3. Authentifizieren Sie Ihr Konto

Schritt 2: Ein Flows Engine-Projekt bereitstellen

Wechseln Sie in das wxflows-Verzeichnis:

cd wxflows

In diesem Repository ist bereits ein wxflows-Projekt für Sie eingerichtet, mit den folgenden Werten:

• Definiert einen Endpunkt api/mcp-example für das Projekt.
• Importiert das google_books-Werkzeug mit einer Beschreibung für die Büchersuche und der Angabe von Feldern books|book.
• Importiert das wikipedia-Werkzeug mit einer Beschreibung für Wikipedia-Suchen und der Angabe von Feldern search|page.

Sie können diese Werkzeugkonfiguration auf einem Flows Engine-Endpunkt bereitstellen, indem Sie Folgendes ausführen:

wxflows deploy

Dieser Befehl stellt den definierten Endpunkt und die Werkzeuge bereit, die vom wxflows SDK in Ihrer Anwendung verwendet werden.

Schritt 3: Umgebungsvariablen einrichten

Kopieren Sie aus dem Stammverzeichnis des Projekts die Beispiel-Umgebungsdatei, um Ihre .env-Datei zu erstellen:

cp .env.sample .env

Bearbeiten Sie die .env-Datei und fügen Sie Ihre Anmeldeinformationen hinzu, wie API-Schlüssel und andere erforderliche Umgebungsvariablen. Stellen Sie sicher, dass die Anmeldeinformationen korrekt sind, damit sich die Werkzeuge authentifizieren und mit externen Diensten interagieren können.

Schritt 4: Abhängigkeiten in der Anwendung installieren

Um die Anwendung auszuführen, müssen Sie die erforderlichen Abhängigkeiten installieren:

npm i

Dieser Befehl installiert alle erforderlichen Pakete, einschließlich des @wxflows/sdk-Pakets und aller im Projekt angegebenen Abhängigkeiten.

Schritt 5: Den MCP-Server erstellen

Erstellen Sie den Server, indem Sie Folgendes ausführen:

npm run build

Schritt 6: In einem MCP-Client verwenden

Schließlich können Sie den MCP-Server in einem Client verwenden. Um ihn mit Claude Desktop zu nutzen, fügen Sie die Serverkonfiguration hinzu:

Auf MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Auf Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "wxflows-server": {
      "command": "node",
      "args": ["/path/to/wxflows-server/build/index.js"],
      "env": {
        "WXFLOWS_APIKEY": "YOUR_WXFLOWS_APIKEY",
        "WXFLOWS_ENDPOINT": "YOUR_WXFLOWS_ENDPOINT"
      }
    }
  }
}

Sie können nun Claude Desktop öffnen und sollten die Werkzeuge des wxflows-server aufgelistet sehen. Sie können jetzt die google_books- und wikipedia-Werkzeuge über Claude Desktop testen.

Zusammenfassung

Sie haben nun erfolgreich ein wxflows-Projekt mit google_books- und wikipedia-Werkzeugen eingerichtet, bereitgestellt und ausgeführt. Diese Einrichtung bietet eine flexible Umgebung, um externe Werkzeuge für den Datenabruf zu nutzen, sodass Sie Ihre App mit wxflows weiter ausbauen und erweitern können. Lesen Sie die Anweisungen unter Werkzeuge, um weitere Werkzeuge hinzuzufügen oder eigene Werkzeuge aus Datenbanken, NoSQL, REST- oder GraphQL-APIs zu erstellen.

Support

Bitte kontaktieren Sie uns auf Discord, wenn Sie Fragen haben oder Feedback geben möchten. Wir freuen uns, von Ihnen zu hören!

Installation

Um es mit Claude Desktop zu verwenden, fügen Sie die Serverkonfiguration hinzu:

Auf MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Auf Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "weather-server": {
      "command": "/path/to/weather-server/build/index.js"
    }
  }
}

Debugging

Da MCP-Server über stdio kommunizieren, kann das Debugging herausfordernd sein. Wir empfehlen die Verwendung des MCP Inspector, der als Paketskript verfügbar ist:

npm run inspector

Der Inspector stellt eine URL bereit, um auf Debugging-Werkzeuge in Ihrem Browser zuzugreifen.