IBM watsonx.ai Flows Engine

Import a Tool

  • Overview
  • Installation
  • Authentication
  • Getting Started
  • Node.js CLI
    • Build a Tool
    • Import a Tool
    • Register Tools
    • Deploying Tools

Import a Community Tool

With watsonx.ai Flows Engine, you can import tools built by other developers or share tools you built yourself with the community. To import a tool, you need to have the watsonx.ai Flows Engine Node.js CLI installed and sign up for a free account.


Import a Tool

On GitHub, you can find an overview of tools that can be used in watsonx.ai Flows. Any tool in that repository can be added to your project using the provided

files. For example, to use the "Google Books" tool in your project, run the following command:

wxflows import tool https://raw.githubusercontent.com/IBM/wxflows/refs/heads/main/tools/google_books.zip

This will generate the tool definition for the "Google Books" tool in the

file in your project. You can edit this tool definition or proceed to deploying your watsonx.ai Flows Engine endpoint to use it in your application.


Edit Tool Definition

You can edit the tool definition in the generated

file after importing a tool. You can also register a new tool by creating the tool definition for a new tool in the
file manually:

# tools.graphql
# ...

extend type Query {
  google_books: TC_GraphQL
    @supplies(query: "tc_tools")
    @materializer(
      query: "tc_graphql_tool"
      arguments: [
        {name: "name", const: "google_books"}
        {
          name: "description"
          const: "Retrieve information from Google Books. Find books by search string, for example to search for Daniel Keyes 'Flowers for Algernon' use q: 'intitle:flowers+inauthor:keyes'"
        }
        {name: "fields", const: "books|book"}
      ]
    )
}

After editing the

file, run
to make your tools available.


Share Your Tool(s)

Visit GitHub to learn how to share your tools with the developer community.