Definition
Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs Inheritance: System.ObjectSyntax
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
.ctor Inherited
Inherited from
objectSyntax
Properties
FilePath
Gets or sets the absolute path to the file to read.Syntax
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
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
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
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?