read_project
Understand a codebase before making changes by reading its folder structure and file contents. Returns a directory tree and optionally file contents for specified files.
Instructions
Read the project folder structure and file contents. Use this to understand a codebase before making changes. Returns directory tree and optionally file contents for specified files or all files.
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": {
"sessionId": "<sessionId>"
},
"name": "read_project"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Specific file or subdirectory to read. If omitted, reads the project root. | |
| maxDepth | No | Max directory depth to scan. Default: 3 | |
| sessionId | Yes | Session ID | |
| filePattern | No | Glob pattern to filter files, e.g. '*.ts' or '*.py'. Default: all files. | |
| includeContents | No | If true, also read file contents (not just listing). Default: false for directories, true for individual files. |