feat(read_file): implement CodexCLI-inspired slice/indentation reading modes #10257
Conversation
dosubot
bot
added
size:XXL
Re-review complete for c9fdfa8.
Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues. |
hannesrudolph
force-pushed
the
feat/read-file-codex-api
branch
from
b153038 to
b0362be
Compare
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
| } | ||
|
|
||
| // Map indentation configuration | ||
| if (file.indentation && typeof file.indentation === "object") { |
There was a problem hiding this comment.
createReadFileTool() defines indentation config keys as anchorLine/maxLevels/includeSiblings/includeHeader, but convertFileEntries() only reads indentation.anchor_line/max_levels/etc, so a tool call that follows the schema will silently drop indentation settings. Consider accepting both casings (camelCase + snake_case) or aligning the schema and examples to the parser.
Fix it with Roo Code or mention @roomote and request a fix.
| let xmlInfo = "" | ||
| let nativeInfo = "" | ||
|
|
||
| if (result.lineCount === 0) { |
There was a problem hiding this comment.
readSlice() rejects when offset is beyond EOF, but ReadFileTool special-cases lineCount === 0 as “offset exceeds file length”. That branch will never be hit with the current readSlice() behavior, so callers always see an error instead of a graceful empty page. If you want “empty content” semantics, consider returning { lineCount: 0, ... } when offset is past EOF rather than throwing.
Fix it with Roo Code or mention @roomote and request a fix.
hannesrudolph
added
the
Issue/PR - Triage
| description: "Configuration for indentation mode. Only used when mode is 'indentation'.", | ||
| properties: { | ||
| anchorLine: { | ||
| type: ["integer", "null"], |
There was a problem hiding this comment.
The native tool schema for read_file advertises indentation.anchorLine/maxLevels/includeSiblings/includeHeader (camelCase), but the examples still show indentation: { maxLevels: 2 } while the parser expects snake_case keys like max_levels. Either the schema should match what the parser accepts, or the parser should accept the camelCase keys models are likely to send.
Fix it with Roo Code or mention @roomote and request a fix.
…g modes Replace line_ranges with new offset/limit/mode API for improved file reading: - Slice mode: simple line-by-line reading with offset pagination - Indentation mode: smart code block extraction based on indentation - Add rich metadata for pagination awareness (hasMoreBefore/After, etc.) - Remove deprecated truncateDefinitions helper - Update tool definition with new parameters and examples - Default maxReadFileLine from 500 to 2000 lines
- Use consistent camelCase in error messages (anchorLine, maxLines instead of snake_case) - Accept both camelCase and snake_case for indentation config in NativeToolCallParser - Continue counting total lines after hitting limit in readSlice() for accurate metadata - Return empty content instead of throwing when offset exceeds file length - Disable strict mode in tool schema when partial reads enabled to allow truly optional params - Update tests to match new behavior
…indentation mode When totalLinesInFile is 0, there are no lines before the anchor point, so hasMoreBefore must be false regardless of the offset/anchorLine value.
hannesrudolph
force-pushed
the
feat/read-file-codex-api
branch
from
7ab3bf4 to
91018ae
Compare
| mode?: ReadMode | ||
| /** Configuration for indentation mode */ | ||
| indentation?: IndentationConfig | ||
| } |
There was a problem hiding this comment.
FileEntry in tool-params.ts still defines limit?: number, but ReadFileTool intentionally ignores entry.limit (uses maxReadFileLine only). This is a contract mismatch: models may send limit expecting it to work, and it will be silently ignored. Either document that limit is ignored (and remove it from schema/types), or wire it through and clamp to maxReadFileLine.
Fix it with Roo Code or mention @roomote and request a fix.
The limit parameter was defined in FileEntry but intentionally ignored by ReadFileTool since the line limit is controlled by the maxReadFileLine setting. This removes the unused type field and parsing code to align the types with actual behavior. - Remove limit from FileEntry interface in tool-params.ts - Remove limit parsing from NativeToolCallParser.convertFileEntries() - Remove limit from FileResult interface in ReadFileTool.ts - Update comment to remove obsolete limit mention
Summary
Implements a new, more intuitive API for the
read_filetool, inspired by OpenAI's Codex CLI read_file implementation. This replaces the previousline_rangesapproach with a cleaner offset/limit/mode-based system that provides better pagination and smarter code extraction capabilities.Changes
New API Parameters: Replace
line_rangeswith:offset: 1-indexed starting line number (default: 1)limit: Maximum lines to return (controlled by maxReadFileLine setting)mode: Eitherslice(simple reading) orindentation(smart block extraction)indentation: Configuration for indentation mode (anchorLine, maxLevels, includeSiblings, includeHeader)New
read-file-content.tsmodule: Core implementation with:readSlice(): Simple line-by-line reading with offset paginationreadIndentationBlock(): Smart extraction of code blocks based on indentation levelsEnhanced Model Awareness: Tool descriptions now include the configured line limit so models understand pagination constraints
Improved Default Limit: Changed default maxReadFileLine from 500 to 2000 lines for better out-of-box experience
Removed Deprecated Code:
truncateDefinitions.tshelper and its testsCredits
This implementation is inspired by and adapts concepts from OpenAI's Codex CLI, particularly their approach to file reading with offset-based pagination and indentation-aware code block extraction.
Important
Introduces a new API for the
read_filetool with offset/limit/mode-based parameters, enhancing file reading capabilities and replacing the oldline_rangesapproach.line_rangeswithoffset,limit,mode, andindentationparameters inread_filetool.sliceandindentationmodes for file reading.maxReadFileLineincreased from 500 to 2000.readSlice()andreadIndentationBlock()inread-file-content.ts.NativeToolCallParser.tsto handle new parameters.ReadFileTool.tsto use new reading modes.NativeToolCallParser.spec.tsandreadFileTool.spec.ts.read-file-content.ts.truncateDefinitions.tsand related tests.This description was created by
for c9fdfa8. You can customize this summary. It will automatically update as commits are pushed.