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

# AgentToolInput

> Represents the input parameters for the Agent tool. The Agent tool launches specialized agents (subprocesses) that autonomously handle complex tasks.

## Definition

**Assembly:** CloudNimble.ClaudeEssentials.dll

**Namespace:** CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.AgentToolInput
```

## Summary

Represents the input parameters for the Agent tool.
The Agent tool launches specialized agents (subprocesses) that autonomously handle complex tasks.

## Remarks

Each agent type has specific capabilities and tools available to it.
Available agent types include: general-purpose, Explore, Plan, claude-code-guide, and others.

This type reflects the latest Agent tool schema including
team collaboration fields such as [AgentToolInput.Name](https://si.nimbleapps.cloud/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Inputs/AgentToolInput.md#name), [AgentToolInput.TeamName](https://si.nimbleapps.cloud/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Inputs/AgentToolInput.md#teamname), and [AgentToolInput.Mode](https://si.nimbleapps.cloud/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Inputs/AgentToolInput.md#mode).

## Constructors

###  .ctor

#### Syntax

```csharp theme={"dark"}
public AgentToolInput()
```

###  .ctor Inherited

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

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

###  Description

Gets or sets a short (3-5 word) description of the task.

#### Syntax

```csharp theme={"dark"}
public string Description { get; set; }
```

#### Property Value

Type: `string`

###  Effort

Gets or sets the reasoning effort for this agent. Ignored when `subagent_type` is `fork`.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<CloudNimble.ClaudeEssentials.Hooks.ReasoningEffort> Effort { get; set; }
```

#### Property Value

Type: `System.Nullable<CloudNimble.ClaudeEssentials.Hooks.ReasoningEffort?>?`

### &#x20;Isolation

Gets or sets the isolation mode for the spawned agent.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<CloudNimble.ClaudeEssentials.Hooks.AgentIsolationMode> Isolation { get; set; }
```

#### Property Value

Type: `System.Nullable<CloudNimble.ClaudeEssentials.Hooks.AgentIsolationMode?>?`

### &#x20;Mode

Gets or sets the permission mode. This value is deprecated and ignored: subagents inherit the parent session's permission mode.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<CloudNimble.ClaudeEssentials.Hooks.PermissionMode> Mode { get; set; }
```

#### Property Value

Type: `System.Nullable<CloudNimble.ClaudeEssentials.Hooks.PermissionMode?>?`

### &#x20;Model

Gets or sets the optional model override for this agent. Takes precedence over the agent definition's
model frontmatter. If omitted, uses the agent definition's model, or inherits from the parent.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<CloudNimble.ClaudeEssentials.Hooks.ClaudeModel> Model { get; set; }
```

#### Property Value

Type: `System.Nullable<CloudNimble.ClaudeEssentials.Hooks.ClaudeModel?>?`

#### Remarks

See [ClaudeModel](https://si.nimbleapps.cloud/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/ClaudeModel.md) for possible values.

### &#x20;Name

Gets or sets the name for the spawned agent. Makes it addressable via `SendMessage({to: name})` while running.

#### Syntax

```csharp theme={"dark"}
public string Name { get; set; }
```

#### Property Value

Type: `string?`

### &#x20;Prompt

Gets or sets the task for the agent to perform.

#### Syntax

```csharp theme={"dark"}
public string Prompt { get; set; }
```

#### Property Value

Type: `string`

### &#x20;RunInBackground

Gets or sets a value indicating whether to run this agent in the background. Agents run in the background by default.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<bool> RunInBackground { get; set; }
```

#### Property Value

Type: `System.Nullable<bool>?`

### &#x20;SubagentType

Gets or sets the type of specialized agent to use for this task.

#### Syntax

```csharp theme={"dark"}
public string SubagentType { get; set; }
```

#### Property Value

Type: `string?`

### &#x20;TeamName

Gets or sets the team name. This value is deprecated and ignored: the session has a single implicit team.

#### Syntax

```csharp theme={"dark"}
public string TeamName { get; set; }
```

#### Property Value

Type: `string?`

## Methods

### &#x20;Equals Inherited Virtual

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

#### Syntax

```csharp theme={"dark"}
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={"dark"}
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={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetType Inherited

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

#### Syntax

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

#### Returns

Type: `System.Type`

### &#x20;MemberwiseClone Inherited

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

#### Syntax

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

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

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

#### Syntax

```csharp theme={"dark"}
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={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


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