docs: fix documentation issues #513
Open
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
The README documentation used `prompt` as a SubAgent field name, but the actual code uses `system_prompt`. This caused confusion for users following the documentation. - Update SubAgent TypedDict definition in README.md - Update SubAgent TypedDict definition in libs/deepagents/README.md - Update field description from `prompt` to `system_prompt`
The README incorrectly suggested importing async_create_deep_agent, which doesn't exist. The function was folded into create_deep_agent. Updated to correctly explain async usage via ainvoke()/astream().
Add 'Security Considerations' section to README.md documenting: - Execute tool risks and mitigations - Recommended security practices (sandboxing, virtual mode) - Trust model explanation
Add Windows Symlink Protection section explaining that O_NOFOLLOW is not available on Windows and recommending mitigations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
This PR addresses multiple documentation issues to improve accuracy and add missing security guidance.
Changes
Files Changed
README.mdlibs/deepagents/README.mdDetailed Changes
1 - Fix SubAgent.prompt → system_prompt naming
The README documentation used
promptas a SubAgent field name, but the actual code usessystem_prompt. Updated:prompttosystem_prompt2 - Document Windows O_NOFOLLOW limitation
Added documentation explaining that
O_NOFOLLOWsymlink protection is not available on Windows, with recommended mitigations:virtual_mode=True3 - Remove async_create_deep_agent mention
The README incorrectly suggested importing
async_create_deep_agent, which doesn't exist. Updated to correctly explain async usage viaainvoke()/astream().4 - Add execute tool security documentation
Added comprehensive "Security Considerations" section including: