IBM wxflows

官方

IBM 提供的工具平台,用於建置、測試及部署適用於任何資料來源的工具。

你可以用 IBM Wxflows MCP 做什麼?

  • 透過 google_books 搜尋書籍 — 請您的助手使用已部署的 Google Books 工具,依書名、作者或關鍵字尋找書籍。
  • 查閱 wikipedia 的維基百科條目 — 透過已部署的 Wikipedia 工具,擷取指定主題的摘要或頁面詳細資訊。
  • 部署自訂工具設定 — 使用 wxflows deploy 發布您自己的端點,並匯入來自 REST、GraphQL、資料庫或 NoSQL 來源的工具。
  • 將伺服器連線至 MCP 用戶端 — 設定 Claude Desktop 或其他 MCP 主機,以探索並呼叫您已部署的 Flows Engine 工具。

文件

使用 watsonx.ai Flows Engine 與模型上下文協定 (MCP)

以下是一個逐步教學,說明如何使用 wxflows 設定和部署專案,包括安裝必要工具、部署應用程式,以及在本機執行。

此範例包含以下部分:

  • MCP TypeScript SDK (mcp 伺服器)
  • wxflows SDK (工具)

您可以使用任何支援的 MCP 用戶端

本指南將引導您安裝 wxflows CLI、初始化並部署專案,以及在本機執行應用程式。我們將以 google_bookswikipedia 工具作為範例,示範如何使用 wxflows 進行工具呼叫。

開始之前

複製此儲存庫並開啟正確的目錄:

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

步驟 1:設定 wxflows

在您開始使用 watsonx.ai Flows Engine 建置 AI 應用程式之前:

  1. 註冊 免費帳戶
  2. 下載並安裝 Node.js CLI
  3. 驗證 您的帳戶

步驟 2:部署 Flows Engine 專案

進入 wxflows 目錄:

cd wxflows

此儲存庫中已為您設定好一個 wxflows 專案,包含以下內容:

  • 定義端點 api/mcp-example 供專案使用。
  • 匯入 google_books 工具,包含用於搜尋書籍的描述,並指定欄位 books|book
  • 匯入 wikipedia 工具,包含用於 Wikipedia 搜尋的描述,並指定欄位 search|page

您可以透過執行以下命令,將此工具設定部署到 Flows Engine 端點:

wxflows deploy

此命令會部署定義的端點和工具,這些將由您應用程式中的 wxflows SDK 使用。

步驟 3:設定環境變數

從專案的根目錄複製範例環境檔案,以建立您的 .env 檔案:

cp .env.sample .env

編輯 .env 檔案並新增您的憑證,例如 API 金鑰和其他必要的環境變數。確保憑證正確,以便工具能夠驗證並與外部服務互動。

步驟 4:在應用程式中安裝相依性

要執行應用程式,您需要安裝必要的相依性:

npm i

此命令會安裝所有必要的套件,包括 @wxflows/sdk 套件以及專案中指定的任何相依性。

步驟 5:建置 MCP 伺服器

透過執行以下命令來建置伺服器:

npm run build

步驟 6:在 MCP 用戶端中使用

最後,您可以在用戶端中使用 MCP 伺服器。若要與 Claude Desktop 搭配使用,請新增伺服器設定:

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

您現在可以開啟 Claude Desktop,應該會看到來自 wxflows-server 的工具列出。您現在可以透過 Claude Desktop 測試 google_bookswikipedia 工具。

摘要

您現在已成功設定、部署並執行了一個包含 google_bookswikipedia 工具的 wxflows 專案。此設定提供了一個靈活的環境,可利用外部工具進行資料擷取,讓您能夠進一步使用 wxflows 建置和擴展您的應用程式。請參閱工具中的說明,以新增更多工具,或從資料庫、NoSQL、REST 或 GraphQL API 建立您自己的工具。

支援

如果您有任何問題或想分享回饋,請在 Discord 上與我們聯繫。我們很樂意聽取您的意見!

安裝

若要與 Claude Desktop 搭配使用,請新增伺服器設定:

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

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

除錯

由於 MCP 伺服器透過 stdio 進行通訊,除錯可能具有挑戰性。我們建議使用 MCP Inspector,它可作為套件腳本使用:

npm run inspector

Inspector 將提供一個 URL,以便在您的瀏覽器中存取除錯工具。