Skip to content

docs: Add strict_json_schema and is_enabled to FunctionTool docs #1486

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

Closed
wants to merge 1 commit into from
Closed

docs: Add strict_json_schema and is_enabled to FunctionTool docs #1486

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
2 changes: 2 additions & 0 deletions docs/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@ Sometimes, you don't want to use a Python function as a tool. You can directly c
- `description`
- `params_json_schema`, which is the JSON schema for the arguments
- `on_invoke_tool`, which is an async function that receives a [`ToolContext`][agents.tool_context.ToolContext] and the arguments as a JSON string, and must return the tool output as a string.
- `strict_json_schema`: Whether the JSON schema is in strict mode. It's recommended to set this to `True`.
- `is_enabled`: Whether the tool is enabled. This can be a boolean or a callable that takes the run context and agent, and returns whether the tool is enabled.

```python
from typing import Any
Expand Down