Add security notice to file management tool (#11878)

Add security notice to file management tool

---------

Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
pull/11789/head
Eugene Yurtsev 9 months ago committed by GitHub
parent cb7e12f6ba
commit c2c0814a94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -29,7 +29,25 @@ _FILE_TOOLS = {
class FileManagementToolkit(BaseToolkit):
"""Toolkit for interacting with a Local Files."""
"""Toolkit for interacting with local files.
*Security Notice*: This toolkit provides methods to interact with local files.
If providing this toolkit to an agent on an LLM, ensure you scope
the agent's permissions to only include the necessary permissions
to perform the desired operations.
By **default** the agent will have access to all files within
the root dir and will be able to Copy, Delete, Move, Read, Write
and List files in that directory.
Consider the following:
- Limit access to particular directories using `root_dir`.
- Use filesystem permissions to restrict access and permissions to only
the files and directories required by the agent.
- Limit the tools available to the agent to only the file operations
necessary for the agent's intended use.
- Sandbox the agent by running it in a container.
"""
root_dir: Optional[str] = None
"""If specified, all file operations are made relative to root_dir."""

Loading…
Cancel
Save