IBM watsonx.ai Flows Engine

Import a Tool

  • Overview
  • Installation
  • Authentication
  • Getting Started
  • Python 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 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 "Wikipedia" tool in your project, run the following command:

wxflows init --endpoint-name api/my-project \  
  --import-name wikipedia \  
  --import-package https://raw.githubusercontent.com/IBM/wxflows/refs/heads/main/tools/wikipedia.zip \  
  --import-tool-name wikipedia \  
  --import-tool-description "Retrieve information from Wikipedia." \  
  --import-tool-fields "search|page"  

This will generate the tool definition for the "Wikipedia" 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:

# wxflows.toml  
# ...  

[[wxflows.deployment.endpoint.imports]]  
name = "wikipedia"  
package = "https://raw.githubusercontent.com/IBM/wxflows/refs/heads/main/tools/wikipedia.zip"  

[[wxflows.deployment.endpoint.imports.tools]]  
name = "wikipedia"  
description = """Retrieve information from Wikipedia."""  
fields = "search|page"  

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.