IBM wxflows MCP Server

Использование watsonx.ai Flows Engine с Model Context Protocol (MCP)

Пошаговое руководство по настройке и развертыванию проекта с wxflows, включая установку необходимых инструментов, развертывание приложения и его локальный запуск.

Этот пример состоит из следующих компонентов:

• MCP TypeScript SDK (mcp-сервер)
• wxflows SDK (инструменты)

Вы можете использовать любой из поддерживаемых MCP-клиентов.

Это руководство проведет вас через установку CLI wxflows, инициализацию и развертывание проекта, а также локальный запуск приложения. В качестве примеров для вызова инструментов с wxflows мы будем использовать инструменты google_books и wikipedia.

Перед началом работы

Клонируйте этот репозиторий и откройте нужную директорию:

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

Шаг 1: Настройка wxflows

Прежде чем приступить к созданию AI-приложений с использованием watsonx.ai Flows Engine:

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

Эта команда развертывает определенные конечную точку и инструменты, которые будут использоваться SDK wxflows в вашем приложении.

Шаг 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. Теперь вы можете протестировать инструменты google_books и wikipedia через Claude Desktop.

Итоги

Вы успешно настроили, развернули и запустили проект wxflows с инструментами google_books и wikipedia. Эта настройка предоставляет гибкую среду для использования внешних инструментов для получения данных, позволяя вам в дальнейшем создавать и расширять ваше приложение с помощью 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 для доступа к инструментам отладки в вашем браузере.