mod action_log; mod tool_registry; mod tool_schema; mod tool_working_set; use std::fmt; use std::fmt::Debug; use std::fmt::Formatter; use std::sync::Arc; use anyhow::Result; use gpui::AnyElement; use gpui::Context; use gpui::IntoElement; use gpui::Window; use gpui::{App, Entity, SharedString, Task}; use icons::IconName; use language_model::LanguageModelRequestMessage; use language_model::LanguageModelToolSchemaFormat; use project::Project; pub use crate::action_log::*; pub use crate::tool_registry::*; pub use crate::tool_schema::*; pub use crate::tool_working_set::*; pub fn init(cx: &mut App) { ToolRegistry::default_global(cx); } #[derive(Debug, Clone)] pub enum ToolUseStatus { NeedsConfirmation, Pending, Running, Finished(SharedString), Error(SharedString), } impl ToolUseStatus { pub fn text(&self) -> SharedString { match self { ToolUseStatus::NeedsConfirmation => "".into(), ToolUseStatus::Pending => "".into(), ToolUseStatus::Running => "".into(), ToolUseStatus::Finished(out) => out.clone(), ToolUseStatus::Error(out) => out.clone(), } } } /// The result of running a tool, containing both the asynchronous output /// and an optional card view that can be rendered immediately. pub struct ToolResult { /// The asynchronous task that will eventually resolve to the tool's output pub output: Task>, /// An optional view to present the output of the tool. pub card: Option, } pub trait ToolCard: 'static + Sized { fn render( &mut self, status: &ToolUseStatus, window: &mut Window, cx: &mut Context, ) -> impl IntoElement; } #[derive(Clone)] pub struct AnyToolCard { entity: gpui::AnyEntity, render: fn( entity: gpui::AnyEntity, status: &ToolUseStatus, window: &mut Window, cx: &mut App, ) -> AnyElement, } impl From> for AnyToolCard { fn from(entity: Entity) -> Self { fn downcast_render( entity: gpui::AnyEntity, status: &ToolUseStatus, window: &mut Window, cx: &mut App, ) -> AnyElement { let entity = entity.downcast::().unwrap(); entity.update(cx, |entity, cx| { entity.render(status, window, cx).into_any_element() }) } Self { entity: entity.into(), render: downcast_render::, } } } impl AnyToolCard { pub fn render(&self, status: &ToolUseStatus, window: &mut Window, cx: &mut App) -> AnyElement { (self.render)(self.entity.clone(), status, window, cx) } } impl From>> for ToolResult { /// Convert from a task to a ToolResult with no card fn from(output: Task>) -> Self { Self { output, card: None } } } #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone)] pub enum ToolSource { /// A native tool built-in to Zed. Native, /// A tool provided by a context server. ContextServer { id: SharedString }, } /// A tool that can be used by a language model. pub trait Tool: 'static + Send + Sync { /// Returns the name of the tool. fn name(&self) -> String; /// Returns the description of the tool. fn description(&self) -> String; /// Returns the icon for the tool. fn icon(&self) -> IconName; /// Returns the source of the tool. fn source(&self) -> ToolSource { ToolSource::Native } /// Returns true iff the tool needs the users's confirmation /// before having permission to run. fn needs_confirmation(&self, input: &serde_json::Value, cx: &App) -> bool; /// Returns the JSON schema that describes the tool's input. fn input_schema(&self, _: LanguageModelToolSchemaFormat) -> Result { Ok(serde_json::Value::Object(serde_json::Map::default())) } /// Returns markdown to be displayed in the UI for this tool. fn ui_text(&self, input: &serde_json::Value) -> String; /// Runs the tool with the provided input. fn run( self: Arc, input: serde_json::Value, messages: &[LanguageModelRequestMessage], project: Entity, action_log: Entity, cx: &mut App, ) -> ToolResult; } impl Debug for dyn Tool { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { f.debug_struct("Tool").field("name", &self.name()).finish() } }