GetDirectoryListing
FileTools
Description
Get the complete overview of your directories! GetDirectoryListing delivers detailed information about all files and subfolders - with options for recursive listing, filtering, and metadata queries.
With flexible parameters, you can control whether only files, only directories, or both are listed. Perfect for file inventories, backup planning, and directory analyses.
Why This Tool Stands Out
- Complete Overview of all contents
- Filter Options for precise lists
- Size Information for every item
- Recursive Listing possible
Perfect for:
System administrators who analyze disk space; developers who check file structures; data processors who create inventories; and anyone who needs detailed directory information. Ideal for backup scripts and file organization.
Workflow support; time savings depend on the task
Instead of navigating through folders manually and counting files, get structured lists with all metadata - via API call and ready for further processing.
JSON Parameters
- directoryPath REQUIRED (String)The path of the directory to list. Example: "C:\\Documents"
- recursive OPTIONAL (Boolean)If true, all subdirectories are listed as well. Default: false
- includeFiles OPTIONAL (Boolean)If true, files are included in the listing. Default: true
- includeDirs OPTIONAL (Boolean)If true, directories are included in the listing. Default: true
Example Call
{
"tool": "GetDirectoryListing",
"params": {
"directoryPath": "C:\\Projects",
"recursive": true,
"includeFiles": true,
"includeDirs": true
}
}
Return Values
The tool returns an array of item objects, each with the following properties:
- name (String)
The name of the file or directory - path (String)
The full path of the item - isDirectory (Boolean)
True if it is a directory - size (Integer)
Size in bytes (0 for directories) - created (String)
Creation date in ISO format - modified (String)
Last modified date in ISO format
Example Usage
Step-by-step guide:
- Specify the path of the directory you want to list
- Enable "recursive" for a complete tree structure
- Choose whether files and/or directories should be shown
- The tool returns a structured list of all items
- Use the metadata for further processing or analysis
Related Tools
Ready to Analyze Your Directories?
Use GetDirectoryListing for detailed file inventories and backup planning. Integrate it into your workflows now!
Discover All FileTools