Definition
Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Responses Inheritance: System.ObjectSyntax
Summary
Contains detailed information about a file read by the Claude Code Read tool, including its path, content, and line-related metadata.Remarks
The content returned by the Read tool includes line numbers in a specific format: spaces followed by the line number, a tab character, and then the actual content. For example:" 1→using System;"
When using the offset and limit parameters in ReadToolInput,
the ReadToolFileInfo.StartLine and ReadToolFileInfo.NumLines properties will reflect the
subset of lines that were actually returned, while ReadToolFileInfo.TotalLines always
represents the total number of lines in the entire file.
Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Content
Gets or sets the content of the file, formatted with line numbers.Syntax
Property Value
Type:string
Examples
Remarks
The content is formatted usingcat -n style output, where each line is prefixed
with its line number. The format is: spaces for padding, line number, tab character (→),
then the actual line content.
Lines longer than 2000 characters are automatically truncated by Claude Code.
FilePath
Gets or sets the absolute path to the file that was read.Syntax
Property Value
Type:string
Examples
Remarks
This is always an absolute path, regardless of whether the original request used a relative or absolute path. On Windows, this will use backslash separators.NumLines
Gets or sets the number of lines included in this response.Syntax
Property Value
Type:int
Remarks
This value reflects the actual number of lines returned, which may be less than ReadToolFileInfo.TotalLines if theoffset and limit parameters were used
in the original ReadToolInput, or if the file was truncated due to size.
By default, the Read tool returns up to 2000 lines.
StartLine
Gets or sets the starting line number (1-based) of the content in this response.Syntax
Property Value
Type:int
Remarks
Line numbers in Claude Code are 1-based, meaning the first line of a file is line 1. If anoffset was specified in the ReadToolInput, this value
will reflect that offset.
TotalLines
Gets or sets the total number of lines in the entire file.Syntax
Property Value
Type:int
Remarks
This represents the complete line count of the file, regardless of how many lines were actually returned in this response. Use this to determine if the file was partially read (when ReadToolFileInfo.NumLines is less than ReadToolFileInfo.TotalLines).Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?