Definition
Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs Inheritance: System.ObjectSyntax
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, AgentToolInput.TeamName, and AgentToolInput.Mode.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Description
Gets or sets a short (3-5 word) description of the task.Syntax
Property Value
Type:string
Effort
Gets or sets the reasoning effort for this agent. Ignored whensubagent_type is fork.
Syntax
Property Value
Type:System.Nullable<CloudNimble.ClaudeEssentials.Hooks.ReasoningEffort?>?
Isolation
Gets or sets the isolation mode for the spawned agent.Syntax
Property Value
Type:System.Nullable<CloudNimble.ClaudeEssentials.Hooks.AgentIsolationMode?>?
Mode
Gets or sets the permission mode. This value is deprecated and ignored: subagents inherit the parent session’s permission mode.Syntax
Property Value
Type:System.Nullable<CloudNimble.ClaudeEssentials.Hooks.PermissionMode?>?
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
Property Value
Type:System.Nullable<CloudNimble.ClaudeEssentials.Hooks.ClaudeModel?>?
Remarks
See ClaudeModel for possible values.Name
Gets or sets the name for the spawned agent. Makes it addressable viaSendMessage({to: name}) while running.
Syntax
Property Value
Type:string?
Prompt
Gets or sets the task for the agent to perform.Syntax
Property Value
Type:string
RunInBackground
Gets or sets a value indicating whether to run this agent in the background. Agents run in the background by default.Syntax
Property Value
Type:System.Nullable<bool>?
SubagentType
Gets or sets the type of specialized agent to use for this task.Syntax
Property Value
Type:string?
TeamName
Gets or sets the team name. This value is deprecated and ignored: the session has a single implicit team.Syntax
Property Value
Type:string?
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
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
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?