返回市场
JavaScript

JavaScript

作者:IBM104 星标更新:2025-05-02

项目介绍

使用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

第一步:设置wxflows

在开始使用watsonx.ai Flows Engine构建AI应用程序之前:

  1. 注册免费账户
  2. 下载并安装Node.js CLI
  3. 验证您的账户

第二步:部署Flows Engine项目

进入wxflows目录:

cd wxflows

此仓库已经为您设置了一个wxflows项目,具有以下值:

  • 定义一个端点 api/mcp-example用于项目。
  • 导入google_books工具,用于搜索书籍并指定字段books|book
  • 导入wikipedia工具,用于维基百科搜索并指定字段search|page

您可以通过运行以下命令将此工具配置部署到Flows Engine端点:

wxflows deploy

此命令会部署已定义的端点和工具,这些将在您的应用程序中由wxflows SDK使用。

第三步:设置环境变量

从项目的根目录复制样本环境文件以创建.env文件:

cp .env.sample .env

编辑.env文件并添加您的凭据,如API密钥和其他所需环境变量。确保凭据正确,以便工具能够认证并与外部服务交互。

第四步:在应用程序中安装依赖项

要运行应用程序,需要安装必要的依赖项:

npm i

此命令会安装所有必需的包,包括@wxflows/sdk包以及项目中指定的任何其他依赖项。

第五步:构建MCP服务器

通过运行以下命令构建服务器:

npm run build

第六步:在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项目,并进行了部署和运行。此设置提供了一个灵活的环境,利用外部工具进行数据检索,允许您进一步构建和扩展您的应用程序。请参阅工具中的说明以添加更多工具或从数据库、NoSQL、REST或GraphQL API创建自己的工具。

支持

如果您有任何问题或想要分享反馈,请通过Discord联系我们。我们非常乐意听到您的声音!

安装

要在Claude Desktop中使用,请添加服务器配置:

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

{
  "m_服务器": {
    "weather-server": {
      "command": "/path/to/weather-server/build/index.js"
    }
  }
}

调试

由于MCP服务器通过stdio通信,调试可能会比较困难。我们建议使用MCP Inspector,它作为一个包脚本提供:

npm run inspector

Inspector将提供一个URL,您可以在浏览器中访问调试工具。