PreToolUseEvent

Struct PreToolUseEvent 

Source
pub struct PreToolUseEvent {
    pub tool_name: String,
    pub tool_input: Value,
    pub tool_use_id: String,
    pub history: Vec<Value>,
}
Expand description

Event fired before a tool is executed, enabling validation, modification, or blocking.

This event provides complete visibility into the tool that’s about to be executed, allowing you to implement security policies, modify inputs, or collect telemetry before any potentially dangerous or expensive operations occur.

§Use Cases

  • Security gates: Block dangerous operations (file deletion, network access)
  • Input validation: Ensure tool inputs meet schema or business rules
  • Parameter injection: Add authentication tokens, user context, or default values
  • Rate limiting: Track and limit tool usage per user/session
  • Audit logging: Record who is calling what tools with what parameters

§Fields

  • tool_name: The name of the tool about to execute (e.g., “Bash”, “Read”, “WebFetch”)
  • tool_input: The parameters that will be passed to the tool (as JSON)
  • tool_use_id: Unique identifier for this specific tool invocation
  • history: Read-only snapshot of the conversation history up to this point

§Example: Security Gate

use open_agent::{PreToolUseEvent, HookDecision};
use serde_json::json;

async fn security_gate(event: PreToolUseEvent) -> Option<HookDecision> {
    // Block all Bash commands containing 'rm -rf'
    if event.tool_name == "Bash" {
        if let Some(command) = event.tool_input.get("command") {
            if command.as_str()?.contains("rm -rf") {
                return Some(HookDecision::block(
                    "Dangerous command blocked for safety"
                ));
            }
        }
    }
    None // Allow other tools
}

§Example: Parameter Injection

use open_agent::{PreToolUseEvent, HookDecision};
use serde_json::json;

async fn inject_auth(event: PreToolUseEvent) -> Option<HookDecision> {
    // Add authentication header to all API calls
    if event.tool_name == "WebFetch" {
        let mut modified = event.tool_input.clone();
        modified["headers"] = json!({
            "Authorization": "Bearer secret-token"
        });
        return Some(HookDecision::modify_input(
            modified,
            "Injected auth token"
        ));
    }
    None
}

Fields§

§tool_name: String

Name of the tool about to be executed (e.g., “Bash”, “Read”, “Edit”)

§tool_input: Value

Input parameters for the tool as a JSON value

§tool_use_id: String

Unique identifier for this tool use (for correlation with PostToolUseEvent)

§history: Vec<Value>

Snapshot of conversation history (read-only) - useful for context-aware decisions

Implementations§

Source§

impl PreToolUseEvent

Source

pub fn new( tool_name: String, tool_input: Value, tool_use_id: String, history: Vec<Value>, ) -> Self

Creates a new PreToolUseEvent.

This constructor is typically called by the agent runtime, not by user code. Users receive instances of this struct in their hook handlers.

Trait Implementations§

Source§

impl Clone for PreToolUseEvent

Source§

fn clone(&self) -> PreToolUseEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PreToolUseEvent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more