ReadToolResponse

Represents the response payload returned by the Claude Code Read tool after reading a file.

Definition

Assembly: CloudNimble.ClaudeEssentials.dll

Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Responses

Inheritance: System.Object

Syntax

CloudNimble.ClaudeEssentials.Hooks.Tools.Responses.ReadToolResponse

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 the tool_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:

{
"type": "text",
"file": {
"filePath": "C:\\Projects\\MyApp\\Program.cs",
"content": "     1→using System;\n     2→\n     3→class Program...",
"numLines": 50,
"startLine": 1,
"totalLines": 50
}
}

Constructors

.ctor

Syntax

public ReadToolResponse()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

File

Gets or sets the file information containing the path, content, and line metadata.

Syntax

public CloudNimble.ClaudeEssentials.Hooks.Tools.Responses.ReadToolFileInfo File { get; set; }

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 be null 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

public string Type { get; set; }

Property Value

Type: string

Remarks

Common values include:

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?