Skip to main content

Definition

Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools Inheritance: CloudNimble.ClaudeEssentials.Hooks.Inputs.PreToolUseHookInput<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput>

Syntax

Summary

Represents the complete payload delivered to a PreToolUse hook when an MCP tool is about to be invoked.

Remarks

MCP (Model Context Protocol) tools are dynamically defined by external servers. The tool input is a dynamic dictionary since the schema varies by MCP server and tool. Your hook can inspect the parameters before the MCP tool executes.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.PreToolUseHookInput<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput>

Syntax

.ctor Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput>

Syntax

.ctor Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

AgentId Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the subagent identifier. Present only when the hook fires from within a subagent.

Syntax

Property Value

Type: string?

AgentType Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the agent type name, present within a subagent or on the main thread of a session started with --agent.

Syntax

Property Value

Type: string?

CurrentWorkingDirectory Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the current working directory where Claude Code is running.

Syntax

Property Value

Type: string

Effort Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the reasoning effort applied to the current turn.

Syntax

Property Value

Type: CloudNimble.ClaudeEssentials.Hooks.Inputs.HookEffortInfo?

HookEventName Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the name of the hook event that triggered this input.

Syntax

Property Value

Type: CloudNimble.ClaudeEssentials.Hooks.HookEventName?

McpServer Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput>
Gets or sets the MCP server that provides the tool, when it is an MCP tool.

Syntax

Property Value

Type: CloudNimble.ClaudeEssentials.Hooks.Inputs.McpServerProvenance?

PermissionMode Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the permission mode under which Claude Code is operating.

Syntax

Property Value

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

PromptId Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the UUID correlating a user prompt with all subsequent events until the next prompt.

Syntax

Property Value

Type: string?

SessionId Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the unique identifier for the current Claude Code session.

Syntax

Property Value

Type: string

ToolInput Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput>
Gets or sets the input parameters for the tool. The schema depends on the specific tool being invoked.

Syntax

Property Value

Type: CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput?

ToolName Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput>
Gets or sets the name of the tool being invoked. Common tool names include: Write, Edit, Bash, Read, Grep, Glob, Task, WebFetch, WebSearch. MCP tools follow the pattern: mcp__<server>__<tool>.

Syntax

Property Value

Type: string

ToolUseId Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.McpToolInput>
Gets or sets the unique identifier for this specific tool use instance. Typically follows the pattern: toolu_01ABC123…

Syntax

Property Value

Type: string

TranscriptPath Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the file path to the transcript JSONL file for the current session. This file contains the full conversation history.

Syntax

Property Value

Type: string

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?