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 invocationhistory: 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: StringName of the tool about to be executed (e.g., “Bash”, “Read”, “Edit”)
tool_input: ValueInput parameters for the tool as a JSON value
tool_use_id: StringUnique identifier for this tool use (for correlation with PostToolUseEvent)
history: Vec<Value>Snapshot of conversation history (read-only) - useful for context-aware decisions
Implementations§
Trait Implementations§
Source§impl Clone for PreToolUseEvent
impl Clone for PreToolUseEvent
Source§fn clone(&self) -> PreToolUseEvent
fn clone(&self) -> PreToolUseEvent
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for PreToolUseEvent
impl RefUnwindSafe for PreToolUseEvent
impl Send for PreToolUseEvent
impl Sync for PreToolUseEvent
impl Unpin for PreToolUseEvent
impl UnwindSafe for PreToolUseEvent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more