Skip to content

fix: Call-out that direct method calls must used keyword arguments #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2025
Merged

fix: Call-out that direct method calls must used keyword arguments #209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/user-guide/concepts/tools/tools_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ Every tool added to an agent also becomes a method accessible directly on the ag
result = agent.tool.file_read(path="/path/to/file.txt", mode="view")
```

When calling tools directly as methods, always use keyword arguments - positional arguments are *not* supported for direct method calls:

```python
# This will NOT work - positional arguments are not supported
result = agent.tool.file_read("/path/to/file.txt", "view") # ❌ Don't do this
```

If a tool name contains hyphens, you can invoke the tool using underscores instead:

```python
Expand Down