get_file_overview
Get a structured overview of a file's imports, exports, classes, functions, and variables to understand its purpose without reading the code.
Instructions
Understand what a file does without reading it — shows structure and relationships from the graph.
USE THIS FIRST when you need to understand a file. It replaces reading the file with a structured summary: imports, exports, classes, functions, variables, and how they connect to the rest of the codebase.
Returns:
Imports: what modules are pulled in and which names
Exports: what the file exposes to others
Classes: with methods and their call targets
Functions: with what they call
Variables: with their assignment sources
After this, use get_context with specific node IDs to deep-dive into relationships.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"file": "<file>"
},
"name": "get_file_overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | File path (relative to project root or absolute) | |
| include_edges | No | Include relationship edges like CALLS, EXTENDS (default: true). Set false for faster results. |