IBM wxflows

oficial

Plataforma de ferramentas da IBM para construir, testar e implantar ferramentas para qualquer fonte de dados.

GitHub
119

O que você pode fazer com IBM Wxflows MCP?

  • Pesquisar livros via google_books — peça ao seu assistente para encontrar livros por título, autor ou palavra-chave usando a ferramenta Google Books implantada.
  • Consultar artigos da Wikipédia via wikipedia — recupere resumos ou detalhes de páginas sobre um determinado tópico por meio da ferramenta Wikipédia implantada.
  • Implantar configurações de ferramentas personalizadas — use wxflows deploy para publicar seu próprio endpoint com ferramentas importadas de fontes REST, GraphQL, bancos de dados ou NoSQL.
  • Conectar o servidor a um cliente MCP — configure o Claude Desktop ou outro host MCP para descobrir e invocar as ferramentas do Flows Engine implantadas.

Documentação

Usando o watsonx.ai Flows Engine com o Model Context Protocol (MCP)

Aqui está um tutorial passo a passo para configurar e implantar um projeto com wxflows, incluindo a instalação das ferramentas necessárias, a implantação do aplicativo e sua execução local.

Este exemplo consiste nas seguintes partes:

  • MCP TypeScript SDK (servidor mcp)
  • wxflows SDK (ferramentas)

Você pode usar qualquer um dos clientes MCP suportados.

Este guia orientará você na instalação da CLI do wxflows, na inicialização e implantação de um projeto e na execução do aplicativo localmente. Usaremos as ferramentas google_books e wikipedia como exemplos de chamada de ferramentas com wxflows.

Antes de começar

Clone este repositório e abra o diretório correto:

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

Passo 1: Configurar o wxflows

Antes de começar a criar aplicações de IA usando o watsonx.ai Flows Engine:

  1. Cadastre-se para obter uma conta gratuita
  2. Baixe e instale a CLI Node.js
  3. Autentique sua conta

Passo 2: Implantar um projeto do Flows Engine

Acesse o diretório wxflows:

cd wxflows

Já existe um projeto wxflows configurado para você neste repositório com os seguintes valores:

  • Define um endpoint api/mcp-example para o projeto.
  • Importa a ferramenta google_books com uma descrição para buscar livros e especificar os campos books|book.
  • Importa a ferramenta wikipedia com uma descrição para buscas na Wikipedia e especificar os campos search|page.

Você pode implantar essa configuração de ferramentas em um endpoint do Flows Engine executando:

wxflows deploy

Este comando implanta o endpoint e as ferramentas definidas, que serão usadas pelo SDK wxflows em sua aplicação.

Passo 3: Configurar as Variáveis de Ambiente

No diretório raiz do projeto, copie o arquivo de ambiente de exemplo para criar seu arquivo .env:

cp .env.sample .env

Edite o arquivo .env e adicione suas credenciais, como chaves de API e outras variáveis de ambiente necessárias. Certifique-se de que as credenciais estejam corretas para permitir que as ferramentas se autentiquem e interajam com serviços externos.

Passo 4: Instalar Dependências na Aplicação

Para executar a aplicação, você precisa instalar as dependências necessárias:

npm i

Este comando instala todos os pacotes necessários, incluindo o pacote @wxflows/sdk e quaisquer dependências especificadas no projeto.

Passo 5: Compilar o servidor MCP

Compile o servidor executando:

npm run build

Passo 6: Usar em um cliente MCP

Por fim, você pode usar o servidor MCP em um cliente. Para usar com o Claude Desktop, adicione a configuração do servidor:

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

Agora você pode abrir o Claude Desktop e verá as ferramentas do wxflows-server listadas. Agora você pode testar as ferramentas google_books e wikipedia através do Claude Desktop.

Resumo

Você configurou, implantou e executou com sucesso um projeto wxflows com as ferramentas google_books e wikipedia. Esta configuração oferece um ambiente flexível para aproveitar ferramentas externas para recuperação de dados, permitindo que você continue construindo e expandindo seu aplicativo com wxflows. Veja as instruções em ferramentas para adicionar mais ferramentas ou criar suas próprias ferramentas a partir de Bancos de Dados, NoSQL, APIs REST ou GraphQL.

Suporte

Por favor, entre em contato conosco no Discord se tiver alguma dúvida ou quiser compartilhar feedback. Adoraríamos ouvir você!

Instalação

Para usar com o Claude Desktop, adicione a configuração do servidor:

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

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

Depuração

Como os servidores MCP se comunicam via stdio, a depuração pode ser desafiadora. Recomendamos usar o MCP Inspector, que está disponível como um script de pacote:

npm run inspector

O Inspector fornecerá uma URL para acessar as ferramentas de depuração no seu navegador.