bamboo_agent_core/tools/

mod.rs

//! Tool execution system for Bamboo agents.
//!
//! This module provides a comprehensive framework for defining, registering, and executing
//! tools that can be used by AI agents to interact with external systems.
//!
//! # Architecture
//!
//! The tools system is built around several key components:
//!
//! - **accumulator**: Accumulates partial tool calls from streaming responses
//! - **agentic**: Agentic tool execution with multi-step capabilities
//! - **executor**: Core tool execution logic
//! - **registry**: Tool registration and lookup
//! - **result_handler**: Processes tool results and handles agentic support
//! - **smart_code_review**: Specialized tool for intelligent code review
//! - **types**: Core type definitions for tools
//!
//! # Key Concepts
//!
//! ## Tool Registry
//!
//! Tools are registered in a central [`ToolRegistry`] that maps tool names to their
//! implementations. The registry supports:
//!
//! - Dynamic tool registration
//! - Tool name normalization
//! - Global singleton access via [`global_registry`]
//!
//! ## Tool Execution
//!
//! Tools implement the [`ToolExecutor`] trait and can be executed via [`execute_tool_call`].
//! The execution flow:
//!
//! 1. Parse tool arguments from JSON
//! 2. Execute the tool logic
//! 3. Return a [`ToolResult`] with success/failure status
//!
//! ## Agentic Tools
//!
//! Some tools support "agentic" behavior, allowing multi-step execution:
//!
//! - [`AgenticTool`]: Marker trait for agentic tools
//! - [`AgenticContext`]: Context for agentic execution
//! - [`AgenticToolResult`]: Extended result type with sub-actions
//!
//! # Example
//!
//! ```rust,ignore
//! use async_trait::async_trait;
//! use bamboo_agent::agent::core::tools::{
//!     execute_tool_call, FunctionCall, ToolCall, ToolError, ToolExecutor, ToolResult, ToolSchema,
//! };
//!
//! struct NoopExecutor;
//!
//! #[async_trait]
//! impl ToolExecutor for NoopExecutor {
//!     async fn execute(&self, call: &ToolCall) -> Result<ToolResult, ToolError> {
//!         Err(ToolError::NotFound(call.function.name.clone()))
//!     }
//!
//!     fn list_tools(&self) -> Vec<ToolSchema> {
//!         Vec::new()
//!     }
//! }
//!
//! #[tokio::main]
//! async fn main() {
//!     // Execute a tool call (this example uses a no-op executor).
//!     let call = ToolCall {
//!         id: "call-1".to_string(),
//!         tool_type: "function".to_string(),
//!         function: FunctionCall {
//!             name: "read_file".to_string(),
//!             arguments: r#"{\"path\":\"/tmp/test.txt\"}"#.to_string(),
//!         },
//!     };
//!
//!     let _ = execute_tool_call(&call, &NoopExecutor, None).await;
//! }
//! ```
//!
//! # Re-exports
//!
//! Key types and functions re-exported for convenience:
//!
//! - Accumulator: [`ToolCallAccumulator`], [`PartialToolCall`], [`finalize_tool_calls`]
//! - Agentic: [`AgenticTool`], [`AgenticContext`], [`AgenticToolResult`], [`ToolGoal`]
//! - Executor: [`ToolExecutor`], [`execute_tool_call`], [`ToolError`]
//! - Registry: [`ToolRegistry`], [`Tool`], [`global_registry`]
//! - Types: [`ToolCall`], [`ToolResult`], [`ToolSchema`]

pub mod accumulator;
pub mod agentic;
pub mod bash_completion;
pub mod context;
pub mod execution_contract;
pub mod executor;
pub mod input_guard;
mod output_cap_observation;
pub mod pending_operation;
pub mod registry;
pub mod result_handler;
pub mod smart_code_review;
mod suspension;
pub mod tool_runtime;
pub mod types;

pub use accumulator::{
    finalize_tool_calls, update_partial_tool_call, update_partial_tool_call_indexed,
    PartialToolCall, ToolCallAccumulator,
};
pub use agentic::{
    convert_from_standard_result, convert_to_standard_result, AgenticContext, AgenticTool,
    AgenticToolExecutor, AgenticToolResult, Interaction, InteractionRole, ToolGoal,
};
pub use bash_completion::{BashCompletionInfo, BashCompletionSink};
pub use context::{
    with_executing_session_caller, ExecutingSupervisorObservation, ToolExecutionContext,
    ToolExecutionSessionFlags,
};
pub use execution_contract::{
    retained_tool_execution_for, retained_tool_execution_for_call, retained_tool_owner_lookup,
    with_retained_tool_execution, RetainedToolExecution, FRAMEWORK_ROOT_SPAWN_CONTRACT_V1,
};
mod framework_session;
pub use executor::{execute_tool_call, execute_tool_call_with_context, ToolError, ToolExecutor};
pub use framework_session::{
    FrameworkSessionToolGuard, FrameworkSessionToolKind, HostFrameworkSessionTool,
};
pub use output_cap_observation::{observed_tool_output_cap, scope_tool_output_cap};
pub use pending_operation::{PendingToolOperation, PENDING_TOOL_OPERATION_METADATA_KEY};
pub use registry::{
    global_registry, normalize_tool_name, RegistryError, SharedTool, Tool, ToolRegistry,
};
pub use result_handler::{
    execute_sub_actions, handle_tool_result_with_agentic_support,
    handle_tool_result_with_agentic_support_and_persistence, is_waiting_for_children_control,
    parse_tool_args, parse_tool_args_best_effort, send_clarification_request,
    tool_result_requires_suspension, tool_start_arguments_for_display, try_parse_agentic_result,
    ToolHandlingOutcome, MAX_SUB_ACTIONS,
};
pub use smart_code_review::SmartCodeReviewTool;
pub use suspension::{
    capture_suspension_restriction, current_tool_suspension_scope, observe_tool_suspension,
    suspension_allowed, suspension_running_violated, with_suspension_disabled,
    with_suspension_disabled_observed, SuspensionRestriction, ToolSuspensionObservation,
};
pub use tool_runtime::{
    AsyncToolCompletionInfo, AsyncToolCompletionSink, AsyncWaitKind, RunningCompletion,
    RunningHandle, ToolClass, ToolCtx, ToolOutcome, ToolResultFuture,
};
pub use types::{FunctionCall, FunctionSchema, ToolCall, ToolResult, ToolResultImage, ToolSchema};

/// Classification of a tool call for approval purposes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ToolMutability {
    ReadOnly,
    Mutating,
}

/// Read-only tools that don't require user approval.
const READ_ONLY_TOOLS: &[&str] = &[
    "Read",
    "GetFileInfo",
    "Glob",
    "Grep",
    "WebFetch",
    "WebSearch",
    "ViewImage",
    "Workspace",
    "BashOutput",
    "session_note",
    "memory_note",
    "session_history",
    "session_history_current",
    "bamboo_diagnostics",
    "recall",
    "session_inspector",
    "archive_context",
    "compact_context",
    "Sleep",
    // The goal self-report tool records a status only; the durable goal-state
    // mutation happens in the engine, and it touches no user-facing state, so it
    // never needs approval.
    "update_goal",
    // `notify` (an overlay tool, like `compact_context`/`session_inspector`
    // above) fires an outbound OS popup / push side effect but mutates
    // nothing in the session or workspace and produces no result the model
    // reads back — safe both to run in the concurrent read-only batch
    // (`ToolExecutor::tool_concurrency_safe`, which name-matches here since
    // overlay tools aren't in a `BuiltinToolExecutor` registry for their own
    // `Tool::classify()` to be consulted) and to allow through the Plan Mode
    // gate (surfacing a heads-up is exactly the "needs attention" case Plan
    // Mode shouldn't block).
    "notify",
];

/// Classify a tool call as read-only or mutating.
pub fn classify_tool(tool_name: &str) -> ToolMutability {
    if READ_ONLY_TOOLS
        .iter()
        .any(|&t| t.eq_ignore_ascii_case(tool_name))
    {
        ToolMutability::ReadOnly
    } else {
        ToolMutability::Mutating
    }
}

/// Shared Plan-mode authorization gate used by agent loops and direct tool
/// dispatch. Unknown tools fail closed as mutating; only read-only tools and
/// the bounded pause/clarification set are admitted.
pub fn plan_mode_allows_tool(tool_name: &str) -> bool {
    classify_tool(tool_name) == ToolMutability::ReadOnly
        || [
            "EnterPlanMode",
            "ExitPlanMode",
            "request_permissions",
            "archive_context",
            "compact_context",
            // This mixed-action tool checks Plan posture itself: target
            // discovery is read-only, while send/reply remain forbidden.
            "session_message",
        ]
        .iter()
        .any(|allowed| allowed.eq_ignore_ascii_case(tool_name))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn diagnostics_is_read_only_in_shared_plan_gate() {
        assert_eq!(
            classify_tool("bamboo_diagnostics"),
            ToolMutability::ReadOnly
        );
        assert!(plan_mode_allows_tool("bamboo_diagnostics"));
        assert!(plan_mode_allows_tool("BAMBOO_DIAGNOSTICS"));
        assert!(!plan_mode_allows_tool("bamboo_diagnostics_repair"));
    }

    #[test]
    fn classify_compact_context_as_read_only() {
        assert_eq!(classify_tool("compact_context"), ToolMutability::ReadOnly);
    }

    #[test]
    fn classify_archive_context_as_read_only() {
        assert_eq!(classify_tool("archive_context"), ToolMutability::ReadOnly);
        assert!(plan_mode_allows_tool("ARCHIVE_CONTEXT"));
    }

    #[test]
    fn classify_compact_context_case_insensitive() {
        assert_eq!(classify_tool("Compact_Context"), ToolMutability::ReadOnly);
        assert_eq!(classify_tool("COMPACT_CONTEXT"), ToolMutability::ReadOnly);
    }

    #[test]
    fn classify_write_as_mutating() {
        assert_eq!(classify_tool("Write"), ToolMutability::Mutating);
    }

    #[test]
    fn session_message_plan_entry_keeps_mutating_name_classification() {
        assert!(plan_mode_allows_tool("session_message"));
        assert_eq!(classify_tool("session_message"), ToolMutability::Mutating);
        assert!(!plan_mode_allows_tool("session_control"));
    }

    #[test]
    fn classify_unknown_as_mutating() {
        assert_eq!(
            classify_tool("totally_unknown_tool"),
            ToolMutability::Mutating
        );
    }

    #[test]
    fn classify_all_read_only_tools() {
        for name in READ_ONLY_TOOLS {
            assert_eq!(
                classify_tool(name),
                ToolMutability::ReadOnly,
                "{name} should be classified as read-only"
            );
        }
    }
}