docs: add ToolContext section for advanced tool metadata #1868
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| `ToolContext` provides the same `.context` property as `RunContextWrapper`, | ||
| plus additional fields specific to the current tool call: | ||
|
|
||
| - `tool_name` – the name of the tool being invoked |
There was a problem hiding this comment.
Can you specify this please?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added a short section in
context.mdexplaining how to useToolContext, which extendsRunContextWrapperand gives access to tool metadata such astool_name,tool_call_id, andtool_arguments.Why
This helps developers understand when to use
ToolContextfor advanced cases, without replacing the existingRunContextWrapperexamples.Changes
Notes
This PR updates only the documentation. No code or API changes were made.
Thanks for reviewing!