list_directory:The 'list_directory' tool allows users to list the contents of a specified directory by providing an absolute path starting with '/'. Ensure that the 'dir_path' exists before using the tool. The tool is subject to permission restrictions, typically allowing access only to the current working directory. Attempting to list directories outside of these permissions will result in an 'Access denied' error. The tool does not support relative paths, and all paths must be absolute. It is primarily intended for use within permitted directories. Users should be aware that any attempt to access directories outside the allowed scope will result in an error message indicating restricted access.
copy_file:The 'copy_file' tool facilitates the copying of files by requiring absolute paths for both the source and destination, ensuring that the file types are consistent. It operates strictly within the current working directory, meaning it can only access and copy files located within this directory. Attempting to copy files from outside this directory will result in an 'Access denied' error. The tool does not manage permission changes or access rights, so users must ensure that they have the necessary permissions for both the source and destination paths. It is designed for use within the same file system and does not support copying files across different file systems or network locations. The tool is not intended for renaming or converting file formats, and users should verify paths to prevent overwriting existing files. The tool can be invoked multiple times to confirm the state of the file system. Error messages returned by the tool provide clarity on issues encountered during the operation.
write_file: The 'write_file' tool is designed to modify existing .txt files by writing text to them. It requires a valid file path to an existing text file and a properly formatted string for the 'text' parameter. Users must ensure the correct use of escape characters and proper termination of strings to avoid syntax errors, such as 'EOL while scanning string literal'. The 'append' parameter determines whether the text should be added to the end of the file (true) or overwrite the existing content (false). The tool does not support creating new files or modifying non-text files. Users should verify that the file path is correct, the file is accessible, and the text is correctly formatted to prevent errors. The tool does not handle errors related to file permissions or non-existent directories, so users should ensure these are correctly set up before using the tool. Including examples of common pitfalls, such as incorrect string formatting, can help users avoid common errors.
read_file:Tool Name: read_file\n\nTool Description: The read_file tool is designed to read text-based files from disk using a specified file path. It operates strictly within the current working directory and cannot access files outside this directory. The tool is intended for text files only. Ensure the file path is correct, the file exists, and any special characters or non-English text in the file name are properly encoded. If the file is not found or cannot be accessed, the tool will return an error message such as 'Error: no such file or directory: [file_name]'.\n\nRequired Parameters:\n- file_path (str): The path to a valid text file within the current directory.\n\nExample Usage:\n- {'file_path': 'example.txt'}
move_file:The 'move_file' tool enables users to move or rename files using absolute paths for both 'source_path' and 'destination_path'. Both paths must reside within the current working directory, as the tool cannot access files outside this directory. Users are responsible for ensuring they have the necessary permissions for both paths, as the tool does not handle permission changes. If paths are outside the current working directory or permissions are inadequate, an 'access denied' error will occur. The tool does not manage special characters in file names, so users should verify these aspects beforehand. It supports renaming a file within the same directory or moving it to another directory within the working directory. Example usage includes renaming '/path/file.txt' to '/path/new_file.txt'.
file_delete:Tool Name: file_delete. Tool Arguments: {'file_path': 'Absolute path of the file to delete'}. Description: This tool deletes a file at the specified absolute path within the current working directory. Ensure the file path is correct and the file exists. The tool cannot delete files outside the current working directory; attempts to do so will result in an 'Access denied' error. Users should verify file permissions and may need to run the tool with elevated privileges to resolve permission issues. Special characters in file names do not inherently cause issues, but permissions must be correct. Files must be closed in other applications before deletion. Example: Delete '/current/working/directory/file.txt' with correct permissions. Common errors include 'Access denied', which can be resolved by checking directory permissions or adjusting the working directory.
file_search:The 'file_search' tool is designed to locate files within a specified subdirectory using relative paths. It requires two parameters: 'dir_path', which specifies the subdirectory to search in, and 'pattern', a case-sensitive Unix shell wildcard pattern where '*' matches any sequence of characters. The tool does not support absolute paths and must use relative paths within the specified subdirectory. If no files match the pattern, the tool will return an error message indicating that no files were found. Ensure that the pattern accurately reflects the case sensitivity of the file names. Example usage: {'dir_path': 'Academics/Courses/Semester_1', 'pattern': '*case_study*'}. Note that the tool's response depends on the current state of the file system, so results may vary over time.