Sypha AI Docs
FeaturesTools

read_file

Inspect and analyze the technical content within your Sypha project workspace.

read_file

The read_file utility enables Sypha to examine source code, project configurations, and documentation for deeper analysis.

Parameters

  • path (required): The location of the target file.
  • start_line (optional): The initial line number for the reading window.
  • end_line (optional): The concluding line number for the reading window.
  • auto_truncate (optional): When active, Sypha intelligently reads the beginning of extensive files to optimize token usage.

Functional Behavior

The tool outputs the designated file content with visible line numbers (e.g., 1 | export default function). This formatting allows Sypha to accurately reference specific code blocks when suggesting edits via the apply_diff system.

Extended Support

Beyond standard code files, Sypha can process:

  • PDF Documents: Useful for consuming architectural specs or technical manuals.
  • Word Files (.docx): For reviewing design briefs or project requirements.
  • Jupyter Notebooks (.ipynb): For navigating and understanding data analysis scripts.

Reading Methodologies

  1. Full Scan: For standard-sized files, Sypha retrieves the entire content in a single pass.
  2. Windowed Read: For larger files, Sypha isolates the specific line range necessary for the task (e.g., lines 150 through 200).
  3. Intelligent Truncation: For massive files where no range is specified, Sypha provides the file header and a summarized map of the structure (classes and methods) found in the remainder.

Implementation Example

Isolating a specific logic block

<read_file>
  <path>src/services/api-client.ts</path>
  <start_line>25</start_line>
  <end_line>60</end_line>
</read_file>

On this page