Definition
Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Responses Inheritance: System.ObjectSyntax
Summary
Represents the response payload returned by the Claude Code Read tool after reading a file.Remarks
The Read tool reads files from the local filesystem and returns their content along with metadata about the file. This response is received in the ReadPostToolUsePayload when thetool_name is “Read”.
The Read tool supports reading text files, images (PNG, JPG, etc.), PDF files, and Jupyter notebooks (.ipynb).
For text files, content is returned with line numbers. For binary files like images, the content
is presented visually to Claude as it is a multimodal LLM.
Example JSON payload:
Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
File
Gets or sets the file information containing the path, content, and line metadata.Syntax
Property Value
Type:CloudNimble.ClaudeEssentials.Hooks.Tools.Responses.ReadToolFileInfo?
Remarks
This property contains the actual file content and associated metadata such as the number of lines read, the starting line, and the total lines in the file. May benull if the file could not be read or does not exist.
Type
Gets or sets the type of content returned by the Read tool.Syntax
Property Value
Type:string
Remarks
Common values include: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?