IBM wxflows MCP Server

officiel

Plateforme d'outils d'IBM pour construire, tester et déployer des outils pour toute source de données.

Documentation

Utilisation de watsonx.ai Flows Engine avec le Model Context Protocol (MCP)

Voici un tutoriel étape par étape pour configurer et déployer un projet avec wxflows, incluant l'installation des outils nécessaires, le déploiement de l'application et son exécution en local.

Cet exemple se compose des éléments suivants :

  • SDK TypeScript MCP (serveur mcp)
  • SDK wxflows (outils)

Vous pouvez utiliser n'importe lequel des clients MCP pris en charge.

Ce guide vous accompagnera dans l'installation de la CLI wxflows, l'initialisation et le déploiement d'un projet, ainsi que l'exécution de l'application en local. Nous utiliserons les outils google_books et wikipedia comme exemples d'appel d'outils avec wxflows.

Avant de commencer

Clonez ce dépôt et ouvrez le répertoire approprié :

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

Étape 1 : Configurer wxflows

Avant de pouvoir commencer à créer des applications d'IA avec watsonx.ai Flows Engine :

  1. Inscrivez-vous pour obtenir un compte gratuit
  2. Téléchargez et installez la CLI Node.js
  3. Authentifiez votre compte

Étape 2 : Déployer un projet Flows Engine

Placez-vous dans le répertoire wxflows :

cd wxflows

Un projet wxflows est déjà configuré pour vous dans ce dépôt avec les valeurs suivantes :

  • Définit un point de terminaison api/mcp-example pour le projet.
  • Importe l'outil google_books avec une description pour rechercher des livres et spécifier les champs books|book.
  • Importe l'outil wikipedia avec une description pour les recherches Wikipedia et spécifier les champs search|page.

Vous pouvez déployer cette configuration d'outils vers un point de terminaison Flows Engine en exécutant :

wxflows deploy

Cette commande déploie le point de terminaison et les outils définis, qui seront utilisés par le SDK wxflows dans votre application.

Étape 3 : Configurer les variables d'environnement

Depuis le répertoire racine du projet, copiez le fichier d'environnement exemple pour créer votre fichier .env :

cp .env.sample .env

Modifiez le fichier .env et ajoutez vos identifiants, tels que les clés API et autres variables d'environnement requises. Assurez-vous que les identifiants sont corrects pour permettre aux outils de s'authentifier et d'interagir avec les services externes.

Étape 4 : Installer les dépendances dans l'application

Pour exécuter l'application, vous devez installer les dépendances nécessaires :

npm i

Cette commande installe tous les paquets requis, y compris le paquet @wxflows/sdk et toutes les dépendances spécifiées dans le projet.

Étape 5 : Construire le serveur MCP

Construisez le serveur en exécutant :

npm run build

Étape 6 : Utiliser dans un client MCP

Enfin, vous pouvez utiliser le serveur MCP dans un client. Pour l'utiliser avec Claude Desktop, ajoutez la configuration du serveur :

Sur MacOS : ~/Library/Application Support/Claude/claude_desktop_config.json Sur 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"
      }
    }
  }
}

Vous pouvez maintenant ouvrir Claude Desktop et vous devriez voir les outils de wxflows-server listés. Vous pouvez maintenant tester les outils google_books et wikipedia via Claude Desktop.

Résumé

Vous avez maintenant configuré, déployé et exécuté avec succès un projet wxflows avec les outils google_books et wikipedia. Cette configuration offre un environnement flexible pour exploiter des outils externes de récupération de données, vous permettant de continuer à construire et étendre votre application avec wxflows. Consultez les instructions dans outils pour ajouter d'autres outils ou créer vos propres outils à partir de bases de données, NoSQL, API REST ou GraphQL.

Support

N'hésitez pas à nous contacter sur Discord si vous avez des questions ou souhaitez partager vos commentaires. Nous serions ravis de vous entendre !

Installation

Pour utiliser avec Claude Desktop, ajoutez la configuration du serveur :

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

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

Débogage

Étant donné que les serveurs MCP communiquent via stdio, le débogage peut être difficile. Nous recommandons d'utiliser le MCP Inspector, disponible en tant que script de paquet :

npm run inspector

L'Inspector fournira une URL pour accéder aux outils de débogage dans votre navigateur.