Sypha AI Docs
FeaturesTools

list_code_definition_names

Generate a structural map of classes, methods, and types within a target directory.

list_code_definition_names

The list_code_definition_names utility offers a high-level blueprint of your project's internal architecture. It efficiently identifies definitions such as classes, functions, and interfaces across all source assets in a given path.

Parameters

  • path (required): The directory targeted for structural analysis.

Strategic Utility

Reading every file in a new project is resource-intensive and slow. This tool enables Sypha to rapidly visualize the skeleton of your codebase:

  • Architectural Discovery: Analyze how logic and responsibilities are partitioned across files.
  • Rapid Navigation: Pinpoint the location of specific methods or types without performing a full-text scan.
  • Strategic Mapping: Develop a comprehensive plan for dependencies before initiating a major refactor.

Result Representation

Sypha receives a file-by-file breakdown, showing the filename, the definition's line number, and its initial signature:

lib/network.ts:
15 | export class NetworkManager {
50 | async function sendRequest(url: string) {

Language Compatibility

Supports a broad spectrum of modern languages (including JavaScript, Go, Python, and C++) through robust Tree-sitter parsers.

[!NOTE] This utility specifically targets files located at the top level of the designated path and does not recurse into deeper folders. For a full tree visualization, consider using list_files.

On this page