docs: Add external documentation link to LocalShellTool docstring #1547
+5
−1
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
seratch
approved these changes
Aug 21, 2025
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.
This pull request addresses the need for detailed documentation regarding the
LocalShellTool.Per the discussion in a previous pull request, it was decided that adding extensive details to the main documentation page would be too verbose. Instead, the recommended approach was to include a link to the detailed external documentation within the tool's docstring.
This change implements that decision by adding a direct link to the official guide in the
LocalShellTooldocstring. This approach keeps the primary documentation concise while providing a clear path for users to access in-depth information and security best practices for using the tool.