IBM wxflows MCP Server

oficial

Plataforma de herramientas de IBM para construir, probar e implementar herramientas para cualquier fuente de datos

Documentación

Uso de watsonx.ai Flows Engine con el Protocolo de Contexto de Modelo (MCP)

Aquí tienes un tutorial paso a paso para configurar y desplegar un proyecto con wxflows, incluyendo la instalación de las herramientas necesarias, el despliegue de la aplicación y su ejecución local.

Este ejemplo consta de las siguientes piezas:

  • SDK de TypeScript para MCP (servidor mcp)
  • SDK de wxflows (herramientas)

Puedes usar cualquiera de los clientes MCP compatibles.

Esta guía te acompañará en la instalación de la CLI de wxflows, la inicialización y despliegue de un proyecto, y la ejecución de la aplicación localmente. Usaremos las herramientas google_books y wikipedia como ejemplos para la invocación de herramientas con wxflows.

Antes de empezar

Clona este repositorio y abre el directorio correspondiente:

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

Paso 1: Configurar wxflows

Antes de que puedas empezar a construir aplicaciones de IA usando watsonx.ai Flows Engine:

  1. Regístrate para obtener una cuenta gratuita
  2. Descarga e instala la CLI de Node.js
  3. Autentica tu cuenta

Paso 2: Desplegar un proyecto de Flows Engine

Muévete al directorio wxflows:

cd wxflows

Ya hay un proyecto wxflows configurado para ti en este repositorio con los siguientes valores:

  • Define un endpoint api/mcp-example para el proyecto.
  • Importa la herramienta google_books con una descripción para buscar libros y especificando los campos books|book.
  • Importa la herramienta wikipedia con una descripción para búsquedas en Wikipedia y especificando los campos search|page.

Puedes desplegar esta configuración de herramientas en un endpoint de Flows Engine ejecutando:

wxflows deploy

Este comando despliega el endpoint y las herramientas definidas, que serán utilizadas por el SDK de wxflows en tu aplicación.

Paso 3: Configurar las variables de entorno

Desde el directorio raíz del proyecto, copia el archivo de entorno de ejemplo para crear tu archivo .env:

cp .env.sample .env

Edita el archivo .env y añade tus credenciales, como claves de API y otras variables de entorno necesarias. Asegúrate de que las credenciales sean correctas para permitir que las herramientas se autentiquen e interactúen con servicios externos.

Paso 4: Instalar dependencias en la aplicación

Para ejecutar la aplicación necesitas instalar las dependencias necesarias:

npm i

Este comando instala todos los paquetes requeridos, incluyendo el paquete @wxflows/sdk y cualquier dependencia especificada en el proyecto.

Paso 5: Construir el servidor MCP

Construye el servidor ejecutando:

npm run build

Paso 6: Usar en un cliente MCP

Finalmente, puedes usar el servidor MCP en un cliente. Para usarlo con Claude Desktop, añade la configuración del servidor:

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

Ahora puedes abrir Claude Desktop y deberías ver las herramientas de wxflows-server listadas. Ya puedes probar las herramientas google_books y wikipedia a través de Claude Desktop.

Resumen

Has configurado, desplegado y ejecutado con éxito un proyecto de wxflows con las herramientas google_books y wikipedia. Esta configuración proporciona un entorno flexible para aprovechar herramientas externas para la recuperación de datos, permitiéndote seguir construyendo y expandiendo tu aplicación con wxflows. Consulta las instrucciones en herramientas para añadir más herramientas o crear tus propias herramientas desde bases de datos, NoSQL, APIs REST o GraphQL.

Soporte

Por favor, contacta con nosotros en Discord si tienes alguna pregunta o quieres compartir comentarios. ¡Nos encantaría saber de ti!

Instalación

Para usarlo con Claude Desktop, añade la configuración del servidor:

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

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

Depuración

Dado que los servidores MCP se comunican a través de stdio, la depuración puede ser complicada. Recomendamos usar el Inspector de MCP, que está disponible como un script de paquete:

npm run inspector

El Inspector proporcionará una URL para acceder a las herramientas de depuración en tu navegador.