IBM wxflows MCP Server

使用 watsonx.ai Flows Engine 与模型上下文协议 (MCP)

以下是一份分步教程，介绍如何使用 wxflows 设置和部署项目，包括安装必要工具、部署应用以及在本地运行。

本示例包含以下部分：

• MCP TypeScript SDK（mcp 服务器）
• wxflows SDK（工具）

你可以使用任何受支持的 MCP 客户端。

本指南将引导你安装 wxflows CLI、初始化和部署项目，以及在本地运行应用。我们将以 google_books 和 wikipedia 工具为例，演示如何使用 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_books 和 wikipedia 工具。

总结

你现在已成功设置、部署并运行了一个包含 google_books 和 wikipedia 工具的 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，用于在浏览器中访问调试工具。