> ## Documentation Index
> Fetch the complete documentation index at: https://ai.easyaf.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

```csharp theme={null}
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

```csharp theme={null}
public ReadToolInput()
```

###  .ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public Object()
```

## Properties

###  FilePath

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

#### Syntax

```csharp theme={null}
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

```csharp theme={null}
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.

### &#x20;Offset

Gets or sets the line number to start reading from.

#### Syntax

```csharp theme={null}
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.

### &#x20;Pages

Gets or sets the page range for PDF files.

#### Syntax

```csharp theme={null}
public string Pages { get; set; }
```

#### Property Value

Type: `string?`

#### Examples

```csharp theme={null}
"1-5"
```

#### Remarks

Optional. Only applicable to PDF files. Specifies which pages to read,
using formats like `"1-5"`, `"3"`, or `"10-20"`.

For large PDFs (more than 10 pages), a page range must be provided.
Maximum 20 pages per request.

## Methods

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.