IBM wxflows MCP Server

resmi

Platform alat oleh IBM untuk membangun, menguji, dan menyebarkan alat untuk sumber data apa pun

Dokumentasi

Menggunakan watsonx.ai Flows Engine dengan Model Context Protocol (MCP)

Berikut adalah tutorial langkah demi langkah untuk menyiapkan dan menerapkan proyek dengan wxflows, termasuk menginstal alat yang diperlukan, menerapkan aplikasi, dan menjalankannya secara lokal.

Contoh ini terdiri dari bagian-bagian berikut:

  • MCP TypeScript SDK (server mcp)
  • wxflows SDK (alat)

Anda dapat menggunakan klien MCP yang didukung mana pun.

Panduan ini akan memandu Anda menginstal CLI wxflows, menginisialisasi dan menerapkan proyek, serta menjalankan aplikasi secara lokal. Kami akan menggunakan alat google_books dan wikipedia sebagai contoh pemanggilan alat dengan wxflows.

Sebelum Anda mulai

Kloning repositori ini dan buka direktori yang tepat:

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

Langkah 1: Siapkan wxflows

Sebelum Anda dapat mulai membangun aplikasi AI menggunakan watsonx.ai Flows Engine:

  1. Daftar untuk akun gratis
  2. Unduh & instal CLI Node.js
  3. Autentikasi akun Anda

Langkah 2: Terapkan proyek Flows Engine

Pindah ke direktori wxflows:

cd wxflows

Sudah ada proyek wxflows yang disiapkan untuk Anda di repositori ini dengan nilai-nilai berikut:

  • Mendefinisikan titik akhir api/mcp-example untuk proyek.
  • Mengimpor alat google_books dengan deskripsi untuk mencari buku dan menentukan bidang books|book.
  • Mengimpor alat wikipedia dengan deskripsi untuk pencarian Wikipedia dan menentukan bidang search|page.

Anda dapat menerapkan konfigurasi alat ini ke titik akhir Flows Engine dengan menjalankan:

wxflows deploy

Perintah ini menerapkan titik akhir dan alat yang ditentukan, yang akan digunakan oleh SDK wxflows di aplikasi Anda.

Langkah 3: Siapkan Variabel Lingkungan

Dari direktori akar proyek, salin berkas lingkungan contoh untuk membuat berkas .env Anda:

cp .env.sample .env

Edit berkas .env dan tambahkan kredensial Anda, seperti kunci API dan variabel lingkungan lain yang diperlukan. Pastikan kredensialnya benar agar alat dapat mengautentikasi dan berinteraksi dengan layanan eksternal.

Langkah 4: Instal Dependensi di Aplikasi

Untuk menjalankan aplikasi, Anda perlu menginstal dependensi yang diperlukan:

npm i

Perintah ini menginstal semua paket yang diperlukan, termasuk paket @wxflows/sdk dan dependensi apa pun yang ditentukan dalam proyek.

Langkah 5: Bangun server MCP

Bangun server dengan menjalankan:

npm run build

Langkah 6: Gunakan di klien MCP

Terakhir, Anda dapat menggunakan server MCP di klien. Untuk menggunakan dengan Claude Desktop, tambahkan konfigurasi server:

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

Anda sekarang dapat membuka Claude Desktop dan seharusnya melihat alat dari wxflows-server tercantum. Anda sekarang dapat menguji alat google_books dan wikipedia melalui Claude Desktop.

Ringkasan

Anda sekarang telah berhasil menyiapkan, menerapkan, dan menjalankan proyek wxflows dengan alat google_books dan wikipedia. Pengaturan ini menyediakan lingkungan yang fleksibel untuk memanfaatkan alat eksternal untuk pengambilan data, memungkinkan Anda untuk lebih lanjut membangun dan memperluas aplikasi Anda dengan wxflows. Lihat petunjuk di alat untuk menambahkan lebih banyak alat atau membuat alat Anda sendiri dari Database, NoSQL, REST, atau API GraphQL.

Dukungan

Silakan hubungi kami di Discord jika Anda memiliki pertanyaan atau ingin berbagi umpan balik. Kami akan senang mendengarnya dari Anda!

Instalasi

Untuk menggunakan dengan Claude Desktop, tambahkan konfigurasi server:

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

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

Debugging

Karena server MCP berkomunikasi melalui stdio, debugging bisa menjadi tantangan. Kami merekomendasikan menggunakan MCP Inspector, yang tersedia sebagai skrip paket:

npm run inspector

Inspektur akan menyediakan URL untuk mengakses alat debugging di peramban Anda.