Enum ControlRequestKind 

pub enum ControlRequestKind {
    CanUseTool {
        tool_name: String,
        input: Value,
        permission_suggestions: Vec<Value>,
        blocked_path: Option<String>,
        tool_use_id: String,
        agent_id: Option<String>,
        decision_reason: Option<String>,
        title: Option<String>,
        display_name: Option<String>,
        description: Option<String>,
    },
    McpMessage {
        server_name: String,
        message: Value,
    },
    HookCallback {
        callback_id: String,
        input: Value,
        tool_use_id: Option<String>,
    },
    Unknown {
        subtype: String,
        raw: Value,
    },
}

Enumerates the kinds of control requests we handle.

Unknown is the forward-compat catch-all - any subtype the CLI ships that forge-sdk doesn’t yet model lands here with the full payload captured. The dispatcher in client/control_dispatch.rs responds with a control_response error (since we have no handler) and logs a tracing::warn! so callers notice drift.

Variants

CanUseTool

A permission check for a tool call.

Fields

tool_name: String

Tool name the model wants to invoke.

input: Value

The JSON input the model generated.

permission_suggestions: Vec<Value>

Permission-suggestion hints from the binary (may be empty).

blocked_path: Option<String>

Path blocked by workspace sandboxing, when applicable.

tool_use_id: String

Identifier of this tool-use (required; string).

agent_id: Option<String>

Agent identifier when this is a sub-agent request.

decision_reason: Option<String>

Free-form reason the CLI surfaced for why human review is needed (e.g. "workspace not yet trusted").

title: Option<String>

Short title the CLI suggests for the prompt (e.g. "Run tests").

display_name: Option<String>

Display name for the tool call (often a humanised tool name).

description: Option<String>

Long-form description the CLI surfaces in the prompt body.

McpMessage

MCP JSON-RPC message routed in-process. See mcp module for the MCP routing pipeline.

Fields

server_name: String

Name of the in-process MCP server this message is addressed to (matches mcpServers config key).

message: Value

The JSON-RPC request body (initialize / tools/list / tools/call / notifications/initialized).

HookCallback

Hook callback invocation. callback_id was registered at connect time via the initialize control_request. See Plan 3 hooks section.

Fields

callback_id: String

Opaque id assigned by forge-sdk at initialize time.

input: Value

Hook-specific payload; includes hook_event_name to discriminate.

tool_use_id: Option<String>

Tool-use id when the hook fired in a tool-use context.

Unknown

Forward-compat fallback for subtype values forge-sdk doesn’t recognise. The dispatcher responds with an error (since no handler is registered) and logs a warning. This prevents an unknown CLI subtype from panicking the session.

Fields

subtype: String

The unrecognised subtype value.

raw: Value

Full request JSON including request body.

Trait Implementations

impl Clone for ControlRequestKind

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ControlRequestKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ControlRequestKind

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for ControlRequestKind

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.