)]
```
### Get a tool
You can also get a specific `WatsonxTool` by name.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
google_search = watsonx_toolkit.get_tool(tool_name="GoogleSearch")
```
## Invocation
### Invoke the tool with a simple input
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
search_result = google_search.invoke({"q": "IBM"})
search_result
```
```json theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
{'output': '[{"title":"IBM - United States","description":"Technology & Consulting. From next-generation AI to cutting edge hybrid cloud solutions to the deep expertise of IBM Consulting, IBM has what it takes to help\xa0...","url":"https://www.ibm.com/us-en"},{"title":"IBM - Wikipedia","description":"International Business Machines Corporation (using the trademark IBM), nicknamed Big Blue, is an American multinational technology company headquartered in\xa0...","url":"https://en.wikipedia.org/wiki/IBM"},{"title":"IBM Envizi ESG Suite","description":"Envizi systemizes the capture, transformation and consolidation of disparate sustainability data into a single source of truth and delivers actionable insights.","url":"https://www.ibm.com/products/envizi"},{"title":"IBM Research","description":"Tools + Code · BeeAI Framework. Open-source framework for building, deploying, and serving powerful agentic workflows at scale. · Docling. An open-source tool\xa0...","url":"https://research.ibm.com/"},{"title":"IBM SkillsBuild: Free Skills-Based Learning From Technology Experts","description":"IBM SkillsBuildPower your future in tech with job skills, courses, and credentials—for free. Power your future in tech with job skills, courses, and credentials\xa0...","url":"https://skillsbuild.org/"},{"title":"IBM | LinkedIn","description":"Locations · Primary. International Business Machines Corp. · 590 Madison Ave · 90 Grayston Dr · Plaza Independencia 721 · 388 Phahon Yothin Road · Jalan Prof.","url":"https://www.linkedin.com/company/ibm"},{"title":"International Business Machines Corporation (IBM)","description":"PROFITABILITY_AND_INCOME_STATEMENT · 9.60% · (TTM). 3.06% · (TTM). 24.06% · (TTM). 62.75B · (TTM). 6.02B · (TTM). 6.41. BALANCE_SHEET_AND_CASH_FLOW. (MRQ).","url":"https://finance.yahoo.com/quote/IBM/"},{"title":"Zurich - IBM Research","description":"The location in Zurich is one of IBM\'s 12 global research labs. IBM has maintained a research laboratory in Switzerland since 1956.","url":"https://research.ibm.com/labs/zurich"},{"title":"IBM (@ibm) • Instagram photos and videos","description":"Science, Technology & Engineering. We partner with developers, data scientists, CTOs and other creators to make the world work better.","url":"https://www.instagram.com/ibm/?hl=en"},{"title":"IBM Newsroom","description":"News and press releases from around the IBM world. Media contacts. Sources by topic and by region. IBM Media center. Explore IBM\'s latest and most popular\xa0...","url":"https://newsroom.ibm.com/"}]'}
```
To fetch a list of received results, you can execute the below cell.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import json
output = json.loads(search_result.get("output"))
output
```
### Invoke the tool with a configuration
To check if a tool has a config schema and view its properties you can look at the tool's `tool_config_schema`.
In this example, the tool has a config schema that contains `maxResults` parameter to set maximum number of results to be returned.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
google_search.tool_config_schema
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
{'title': 'config schema for GoogleSearch tool',
'type': 'object',
'properties': {'maxResults': {'title': 'Max number of results to return',
'type': 'integer',
'minimum': 1,
'maximum': 20}}}
```
To set `tool_config` parameters, you need to use `set_tool_config()` method and pass correct `dict` according to above `tool_config_schema`.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import json
config = {"maxResults": 3}
google_search.set_tool_config(config)
search_result = google_search.invoke({"q": "IBM"})
output = json.loads(search_result.get("output"))
```
There is supposed to be maximum 3 results.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
print(len(output))
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
3
```
### Invoke the tool with an input schema
We need to get another tool (with an input schema) for the example purpose.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
weather_tool = watsonx_toolkit.get_tool("Weather")
```
To check if a tool has an input schema and view its properties, you can look at the tool's `tool_input_schema`.
In this example, the tool has an input schema that contains one required and one optional parameter.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
weather_tool.tool_input_schema
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
{'type': 'object',
'properties': {'location': {'title': 'location',
'description': 'Name of the location',
'type': 'string'},
'country': {'title': 'country',
'description': 'Name of the state or country',
'type': 'string'}},
'required': ['location']}
```
To correctly pass an input to `invoke()`, you need to create an `invoke_input` dictionary with required parameter as a key with its value.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
invoke_input = {
"location": "New York",
}
weather_result = weather_tool.invoke(input=invoke_input)
weather_result
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
{'output': 'Current weather in New York:\nTemperature: 0°C\nRain: 0mm\nRelative humidity: 63%\nWind: 7.6km/h\n'}
```
This time the output is a single string value. To fetch and print it you can execute the below cell.
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
output = weather_result.get("output")
print(output)
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
Current weather in New York:
Temperature: 0°C
Rain: 0mm
Relative humidity: 63%
Wind: 7.6km/h
```
### Invoke the tool with a ToolCall
We can also invoke the tool with a ToolCall, in which case a ToolMessage will be returned:
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
invoke_input = {
"location": "Los Angeles",
}
tool_call = dict(
args=invoke_input,
id="1",
name=weather_tool.name,
type="tool_call",
)
weather_tool.invoke(input=tool_call)
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
ToolMessage(content='{"output": "Current weather in Los Angeles:\\nTemperature: 8.6°C\\nRain: 0mm\\nRelative humidity: 61%\\nWind: 8.4km/h\\n"}', name='Weather', tool_call_id='1')
```
## Use within an agent
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
from langchain_ibm import ChatWatsonx
llm = ChatWatsonx(
model_id="meta-llama/llama-3-3-70b-instruct",
url="https://us-south.ml.cloud.ibm.com",
project_id="PASTE YOUR PROJECT_ID HERE",
)
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
from langchain.agents import create_agent
tools = [weather_tool]
agent = create_agent(llm, tools)
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
example_query = "What is the weather in Boston?"
stream = agent.stream_events(
{"messages": [("user", example_query)]},
version="v3",
)
for snapshot in stream.values:
snapshot["messages"][-1].pretty_print()
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
================================ Human Message =================================
What is the weather in Boston?
================================== Ai Message ==================================
Tool Calls:
Weather (chatcmpl-tool-6a6c21402c824e43bdd2e8ba390af4a8)
Call ID: chatcmpl-tool-6a6c21402c824e43bdd2e8ba390af4a8
Args:
location: Boston
================================= Tool Message =================================
Name: Weather
{"output": "Current weather in Boston:\nTemperature: -1°C\nRain: 0mm\nRelative humidity: 53%\nWind: 8.3km/h\n"}
================================== Ai Message ==================================
The current weather in Boston is -1°C with 0mm of rain, a relative humidity of 53%, and a wind speed of 8.3km/h.
```
***
## API reference
For detailed documentation of all `WatsonxToolkit` features and configurations head to the [API reference](https://reference.langchain.com/python/integrations/langchain_ibm/WatsonxToolkit/).
***
[Connect these docs](/use-these-docs) to Claude, VSCode, and more via MCP for real-time answers.
[Edit this page on GitHub](https://github.com/langchain-ai/docs/edit/main/src/oss/python/integrations/tools/ibm_watsonx.mdx) or [file an issue](https://github.com/langchain-ai/docs/issues/new/choose).