Skip to content

docs: update Environment Toolset file operations descriptions #1980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
14Emanuel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update Environment Toolset file operations descriptions #1980

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/integrations/environment-toolset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,11 @@ local_environment=LocalEnvironment(
The ***LocalEnvironment*** implementation includes the following tools an
agent can run within a local compute environment:

- ***ReadFile***: Read an existing text file based on agent instructions.
- ***EditFile***: Edit an existing text file based on agent instructions.
- ***WriteFile***: Create a new text file based on agent instructions.
- ***ReadFile***: Read an existing text file based on agent instructions. It supports reading specific line ranges (start_line, end_line) to manage context window limits.
- ***EditFile***: Perform surgical text replacements in an existing file. It requires an exact old_string that appears exactly once in the file, replacing it with a new_string.
- ***WriteFile***: Create or overwrite a text file based on agent instructions. Use this for new files or full rewrites.
- ***Execute***: Execute terminal commands, including running installers,
shell scripts, and program code, based on agent instructions.
shell scripts, and program code, based on agent instructions. It is recommended to use ReadFile instead of shell commands (like cat, head, tail) for file reading.

!!! danger "Danger: Potential data loss, code execution"

Expand Down