Improve read_file tool description with examples

daniel-lxs · daniel-lxs · commit 210c9add7f5c · 2025-11-19T23:59:34.000-05:00
- Add explicit JSON structure documentation
- Include three concrete examples (single file, with line ranges, multiple files)
- Clarify that 'path' is required and 'line_ranges' is optional
- Better explain line range format (1-based inclusive)

This addresses agent confusion by providing clear examples similar to the XML tool definition.
diff --git a/src/core/prompts/tools/native-tools/read_file.ts b/src/core/prompts/tools/native-tools/read_file.ts
@@ -5,7 +5,13 @@ export const read_file = {
 	function: {
 		name: "read_file",
 		description:
-			"Read one or more files and return their contents with line numbers for diffing or discussion. Use line ranges when available to keep reads efficient and combine related files when possible.",
+			"Read one or more files and return their contents with line numbers for diffing or discussion. " +
+			"Structure: { files: [{ path: 'relative/path.ts', line_ranges: ['1-50', '100-150'] }] }. " +
+			"The 'path' is required and relative to workspace. " +
+			"The 'line_ranges' is optional for reading specific sections (format: 'start-end', 1-based inclusive). " +
+			"Example single file: { files: [{ path: 'src/app.ts' }] }. " +
+			"Example with line ranges: { files: [{ path: 'src/app.ts', line_ranges: ['1-50', '100-150'] }] }. " +
+			"Example multiple files: { files: [{ path: 'file1.ts', line_ranges: ['1-50'] }, { path: 'file2.ts' }] }",
 		strict: true,
 		parameters: {
 			type: "object",
