get_symbols_overview

Retrieve a high-level overview of top-level symbols in a file or directory using JSON output. Optimize code understanding before reading, searching, or editing operations.

Instructions

Gets an overview of the given file or directory. For each analyzed file, we list the top-level symbols in the file (name_path, kind). Use this tool to get a high-level understanding of the code symbols. Calling this is often a good idea before more targeted reading, searching or editing operations on the code symbols. Returns a JSON object mapping relative paths of all contained files to info about top-level symbols in the file (name_path, kind).

Input Schema

Name	Required	Description	Default
`max_answer_chars`	No	If the overview is longer than this number of characters, no content will be returned. Don't adjust unless there is really no other way to get the content required for the task. If the overview is too long, you should use a smaller directory instead, (e.g. a subdirectory).
`relative_path`	Yes	The relative path to the file or directory to get the overview of.

Input Schema (JSON Schema)

{
  "properties": {
    "max_answer_chars": {
      "default": 200000,
      "description": "If the overview is longer than this number of characters,\nno content will be returned. Don't adjust unless there is really no other way to get the content\nrequired for the task. If the overview is too long, you should use a smaller directory instead,\n(e.g. a subdirectory).",
      "title": "Max Answer Chars",
      "type": "integer"
    },
    "relative_path": {
      "description": "The relative path to the file or directory to get the overview of.",
      "title": "Relative Path",
      "type": "string"
    }
  },
  "required": [
    "relative_path"
  ],
  "title": "applyArguments",
  "type": "object"
}

Serena