Filesystem Tools

​

Overview

​

Tool Name

filesystem_tools

​

Purpose

​

Functions Available

1. read_file: Read file content with automatic format detection and optional byte limit.
2. read_text_file: Read text files with encoding and optional line numbering.
3. edit_file: Modify files by replacing, inserting, appending, or deleting at line level.
4. read_media_file: Access binary media content or metadata in safe formats.
5. read_multiple_files: Batch read many files with optional shared encoding and metadata.
6. write_file: Create or overwrite files with optional directory creation and encoding.
7. directory_tree: Generate a visual tree of directories with depth control.
8. create_directory: Create folders with optional recursion and permissions.
9. list_allowed_directories: Show the directories your environment permits you to access.
10. list_directory_with_sizes: List directory entries and compute sizes, optionally recursive.
11. move_file: Move or rename files and directories with optional overwrite.
12. search_files: Search by name, content, extension, or regex across a path.
13. get_file_info: Return metadata such as size, timestamps, and permissions.
14. list_directory: Basic listing of directory contents with optional filters.

​

Key Features

​

Input Parameters for Each Function

​

read_file

​

read_text_file

​

edit_file

​

read_media_file

​

read_multiple_files

​

write_file

​

directory_tree

​

create_directory

​

list_allowed_directories

​

list_directory_with_sizes

​

move_file

​

search_files

​

get_file_info

​

list_directory

​

Use Cases

1. Config management
   • Update YAML or JSON settings across environments with read_text_file and edit_file.
2. Log triage
   • Sample the last megabytes of a large log using read_file with max_bytes.
3. Repo structuring
   • Create a new project skeleton with create_directory and verify with directory_tree.
4. Code search
   • Find usages of a function name across a codebase with search_files search_type: "content".
5. Governance checks
   • Pull get_file_info with checksums for release packaging or audit trails.

​

Workflow/How It Works

1. Inspect or search using list_directory, list_directory_with_sizes, or search_files.
2. Read content with read_text_file or read_file. For binaries, use read_media_file.
3. Modify with edit_file or write new content with write_file and optional create_directories.
4. Restructure with move_file or create_directory, then visualize using directory_tree.
5. Collect metadata using get_file_info for validation and documentation.

​

Integration Relevance

• file_manager_tools to register and attach files once created or modified.
• git_action for versioning changes that originate on the filesystem.
• document_index_tools to index folders after writing or reorganizing content.
• project_manager_tools to tie filesystem operations to tasks or milestones.
• artifact_manager_tools to track generated outputs and link them back to runs.

​

Configuration Details

• Use platform appropriate path separators and avoid trailing spaces in paths.
• Default encoding is UTF-8. Specify encodings explicitly when working with legacy files.
• For permission fields, use standard octal strings such as 755 or 644.
• Recursive operations can be expensive on large trees. Apply max_depth and filters.

​

Limitations or Notes

1. All operations respect OS permissions and may fail without proper access.
2. Large files can consume significant memory or time to process. Use limits and sampling.
3. Network mounted volumes may perform differently than local disks.
4. Encoding detection is best effort and may be inaccurate for mixed content files.
5. Concurrent writers can cause conflicts. Coordinate long running edits and moves.

​

Output

• Reads: File content plus encoding info and optional metadata.
• Writes and Edits: Confirmation with file details and sizes.
• Listings: Entries with names, sizes, dates, and optional recursion summaries.
• Trees: A compact visual structure of folders and files.
• Search: Array of matches with paths and match context.
• Metadata: Permissions, timestamps, and checksums when requested.