ReadToolInput

Represents the input parameters for the Read tool. The Read tool reads files from the local filesystem.

Definition

Assembly: CloudNimble.ClaudeEssentials.dll

Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs

Inheritance: System.Object

Syntax

CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.ReadToolInput

Summary

Represents the input parameters for the Read tool. The Read tool reads files from the local filesystem.

Remarks

By default, reads up to 2000 lines starting from the beginning of the file. You can optionally specify a line offset and limit for reading specific portions.

The Read tool can also read images (PNG, JPG, etc.), PDF files, and Jupyter notebooks (.ipynb).

Constructors

.ctor

Syntax

public ReadToolInput()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

FilePath

Gets or sets the absolute path to the file to read.

Syntax

public string FilePath { get; set; }

Property Value

Type: string

Remarks

Must be an absolute path, not a relative path.

Limit

Gets or sets the number of lines to read.

Syntax

public System.Nullable<int> Limit { get; set; }

Property Value

Type: System.Nullable<int>

Remarks

Optional. Only provide if the file is too large to read at once.

Offset

Gets or sets the line number to start reading from.

Syntax

public System.Nullable<int> Offset { get; set; }

Property Value

Type: System.Nullable<int>

Remarks

Optional. Only provide if the file is too large to read at once.

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?