Sypha AI Docs
FeaturesTools

list_files

Inspect and traverse the file hierarchy and project organization within your workspace.

list_files

The list_files utility generates a comprehensive directory map, enabling Sypha to understand the architectural layout and organization of your project.

Parameters

  • path (required): The specific directory target for indexing.
  • recursive (optional): Set this to true to perform a deep scan of nested folders and assets.

Behavioral Details

The tool provides a structured list of file paths. To distinguish between asset types, directories are identified with a trailing forward slash (/).

Resource Filtering

  • Version Control: Sypha intuitively honors your .gitignore settings. During recursive scans, it automatically bypasses high-volume or irrelevant folders such as node_modules or .git.
  • Custom Exclusions: Assets restricted via .syphaignore are either hidden from results or identified with a lock indicator, based on your specific configuration.

Implementation Example

Deep exploration of a specific module

<list_files>
  <path>src/modules/billing</path>
  <recursive>true</recursive>
</list_files>

Performance Optimization

To maintain a responsive interface in massive codebases, recursive listings are capped at a specific threshold (typically 200 items). If a directory exceeds this limit, Sypha will recommend navigating into more specific sub-folders to preserve context clarity.

On this page