pub mod outline; mod tool_registry; mod tool_schema; mod tool_working_set; use std::fmt; use std::fmt::Debug; use std::fmt::Formatter; use std::ops::Deref; use std::sync::Arc; use action_log::ActionLog; use anyhow::Result; use gpui::AnyElement; use gpui::AnyWindowHandle; use gpui::Context; use gpui::IntoElement; use gpui::Window; use gpui::{App, Entity, SharedString, Task, WeakEntity}; use icons::IconName; use language_model::LanguageModel; use language_model::LanguageModelImage; use language_model::LanguageModelRequest; use language_model::LanguageModelToolSchemaFormat; use project::Project; use workspace::Workspace; 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 { InputStillStreaming, NeedsConfirmation, Pending, Running, Finished(SharedString), Error(SharedString), } impl ToolUseStatus { pub fn text(&self) -> SharedString { match self { ToolUseStatus::NeedsConfirmation => "".into(), ToolUseStatus::InputStillStreaming => "".into(), ToolUseStatus::Pending => "".into(), ToolUseStatus::Running => "".into(), ToolUseStatus::Finished(out) => out.clone(), ToolUseStatus::Error(out) => out.clone(), } } pub fn error(&self) -> Option { match self { ToolUseStatus::Error(out) => Some(out.clone()), _ => None, } } } #[derive(Debug)] pub struct ToolResultOutput { pub content: ToolResultContent, pub output: Option, } #[derive(Debug, PartialEq, Eq)] pub enum ToolResultContent { Text(String), Image(LanguageModelImage), } impl ToolResultContent { pub fn len(&self) -> usize { match self { ToolResultContent::Text(str) => str.len(), ToolResultContent::Image(image) => image.len(), } } pub fn is_empty(&self) -> bool { match self { ToolResultContent::Text(str) => str.is_empty(), ToolResultContent::Image(image) => image.is_empty(), } } pub fn as_str(&self) -> Option<&str> { match self { ToolResultContent::Text(str) => Some(str), ToolResultContent::Image(_) => None, } } } impl From for ToolResultOutput { fn from(value: String) -> Self { ToolResultOutput { content: ToolResultContent::Text(value), output: None, } } } impl Deref for ToolResultOutput { type Target = ToolResultContent; fn deref(&self) -> &Self::Target { &self.content } } /// 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, workspace: WeakEntity, cx: &mut Context, ) -> impl IntoElement; } #[derive(Clone)] pub struct AnyToolCard { entity: gpui::AnyEntity, render: fn( entity: gpui::AnyEntity, status: &ToolUseStatus, window: &mut Window, workspace: WeakEntity, cx: &mut App, ) -> AnyElement, } impl From> for AnyToolCard { fn from(entity: Entity) -> Self { fn downcast_render( entity: gpui::AnyEntity, status: &ToolUseStatus, window: &mut Window, workspace: WeakEntity, cx: &mut App, ) -> AnyElement { let entity = entity.downcast::().unwrap(); entity.update(cx, |entity, cx| { entity .render(status, window, workspace, cx) .into_any_element() }) } Self { entity: entity.into(), render: downcast_render::, } } } impl AnyToolCard { pub fn render( &self, status: &ToolUseStatus, window: &mut Window, workspace: WeakEntity, cx: &mut App, ) -> AnyElement { (self.render)(self.entity.clone(), status, window, workspace, 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 if the tool needs the users's confirmation /// before having permission to run. fn needs_confirmation( &self, input: &serde_json::Value, project: &Entity, cx: &App, ) -> bool; /// Returns true if the tool may perform edits. fn may_perform_edits(&self) -> 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; /// Returns markdown to be displayed in the UI for this tool, while the input JSON is still streaming /// (so information may be missing). fn still_streaming_ui_text(&self, input: &serde_json::Value) -> String { self.ui_text(input) } /// Runs the tool with the provided input. fn run( self: Arc, input: serde_json::Value, request: Arc, project: Entity, action_log: Entity, model: Arc, window: Option, cx: &mut App, ) -> ToolResult; fn deserialize_card( self: Arc, _output: serde_json::Value, _project: Entity, _window: &mut Window, _cx: &mut App, ) -> Option { None } } impl Debug for dyn Tool { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { f.debug_struct("Tool").field("name", &self.name()).finish() } }