Struct ToolSpec 

pub struct ToolSpec {
    pub name: String,
    pub description: String,
    pub schema_json: Value,
    pub title: Option<String>,
    pub needs_approval: bool,
}

Declaration of a tool the model may invoke.

Fields

name: String

Unique tool name; the model references this when emitting a ToolCall.

description: String

Human-readable description of what the tool does.

schema_json: Value

JSON Schema object describing the tool’s argument shape.

title: Option<String>

MCP-style human display name for this tool (the title annotation): a friendly label shown to people (e.g. in an approval prompt) while the machine-facing name stays the audit identifier.

None means no curated label was provided; callers derive a display name from name via humanize_tool_name.

needs_approval: bool

Intrinsic “this tool is side-effecting / requires human approval” flag.

When true the tool must be routed through the harness’s human-in-the-loop (HITL) approval gate before it executes, even when no operator-side allow-list names it. Pure, read-only tools leave this false.

This is the per-tool generalization of the old hard-coded approval-by-name list: it maps from the MCP destructiveHint tool annotation, so an upstream connector that advertises a destructive tool is gated per-tool rather than per-connector.

Defaults to false and is skipped when serializing the safe default, so older payloads that omit the field still deserialize as ungated.

Trait Implementations

impl Clone for ToolSpec

fn clone(&self) -> ToolSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.