docs: Correct and clarify LocalShellTool documentation #1538
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
|
Indeed, the tool is confusing, but instead of updating the page with more words, we prefer updating the docstring to have the detailed document page link: https://platform.openai.com/docs/guides/tools-local-shell |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This pull request corrects an inconsistency and clarifies the documentation for the
LocalShellTool.Currently, the
LocalShellToolis listed under the "Hosted tools" section, which is misleading as it does not run on an LLM server. This PR adds a note that explicitly states the tool is not hosted and runs on the local machine. The change also includes a warning about permissions and security, which is critical for users to understand when using a tool that interacts with their local environment.This update will improve the documentation's accuracy and help developers use the tool safely and correctly.