use acp_thread::SUBAGENT_SESSION_ID_META_KEY; use agent_client_protocol as acp; use anyhow::{Result, anyhow}; use futures::FutureExt as _; use gpui::{App, Entity, SharedString, Task, WeakEntity}; use language_model::LanguageModelToolResultContent; use schemars::JsonSchema; use serde::{Deserialize, Serialize}; use std::sync::Arc; use std::{rc::Rc, time::Duration}; use crate::{AgentTool, Thread, ThreadEnvironment, ToolCallEventStream}; /// Spawns a subagent with its own context window to perform a delegated task. /// /// Use this tool when you want to do any of the following: /// - Perform an investigation where all you need to know is the outcome, not the research that led to that outcome. /// - Complete a self-contained task where you need to know if it succeeded or failed (and how), but none of its intermediate output. /// - Run multiple tasks in parallel that would take significantly longer to run sequentially. /// /// You control what the subagent does by providing: /// 1. A task prompt describing what the subagent should do /// 2. A summary prompt that tells the subagent how to summarize its work when done /// 3. A "context running out" prompt for when the subagent is low on tokens /// /// Each subagent has access to the same tools you do. You can optionally restrict /// which tools each subagent can use. /// /// Note: /// - Maximum 8 subagents can run in parallel /// - Subagents cannot use tools you don't have access to /// - If spawning multiple subagents that might write to the filesystem, provide /// guidance on how to avoid conflicts (e.g. assign each to different directories) /// - Instruct subagents to be concise in their summaries to conserve your context #[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)] pub struct SubagentToolInput { /// Short label displayed in the UI while the subagent runs (e.g., "Researching alternatives") pub label: String, /// The initial prompt that tells the subagent what task to perform. /// Be specific about what you want the subagent to accomplish. pub task_prompt: String, /// The prompt sent to the subagent when it completes its task, asking it /// to summarize what it did and return results. This summary becomes the /// tool result you receive. /// /// Example: "Summarize what you found, listing the top 3 alternatives with pros/cons." pub summary_prompt: String, /// Optional: Maximum runtime in milliseconds. If exceeded, the subagent is /// asked to summarize and return. No timeout by default. #[serde(default)] pub timeout_ms: Option, /// Optional: List of tool names the subagent is allowed to use. /// If not provided, the subagent can use all tools available to the parent. /// Tools listed here must be a subset of the parent's available tools. #[serde(default)] pub allowed_tools: Option>, } #[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)] pub struct SubagentToolOutput { pub subagent_session_id: acp::SessionId, pub summary: String, } impl From for LanguageModelToolResultContent { fn from(output: SubagentToolOutput) -> Self { output.summary.into() } } /// Tool that spawns a subagent thread to work on a task. pub struct SubagentTool { parent_thread: WeakEntity, environment: Rc, } impl SubagentTool { pub fn new(parent_thread: WeakEntity, environment: Rc) -> Self { Self { parent_thread, environment, } } fn validate_allowed_tools( allowed_tools: &Option>, parent_thread: &Entity, cx: &App, ) -> Result<()> { let Some(allowed_tools) = allowed_tools else { return Ok(()); }; let thread = parent_thread.read(cx); let invalid_tools: Vec<_> = allowed_tools .iter() .filter(|tool| !thread.tools.contains_key(tool.as_str())) .map(|s| format!("'{s}'")) .collect::>(); if !invalid_tools.is_empty() { return Err(anyhow!( "The following tools do not exist: {}", invalid_tools.join(", ") )); } Ok(()) } } impl AgentTool for SubagentTool { type Input = SubagentToolInput; type Output = SubagentToolOutput; const NAME: &'static str = "subagent"; fn kind() -> acp::ToolKind { acp::ToolKind::Other } fn initial_title( &self, input: Result, _cx: &mut App, ) -> SharedString { input .map(|i| i.label.into()) .unwrap_or_else(|_| "Subagent".into()) } fn run( self: Arc, input: Self::Input, event_stream: ToolCallEventStream, cx: &mut App, ) -> Task> { let Some(parent_thread_entity) = self.parent_thread.upgrade() else { return Task::ready(Err(anyhow!("Parent thread no longer exists"))); }; if let Err(e) = Self::validate_allowed_tools(&input.allowed_tools, &parent_thread_entity, cx) { return Task::ready(Err(e)); } let subagent = match self.environment.create_subagent( parent_thread_entity, input.label, input.task_prompt, input.timeout_ms.map(|ms| Duration::from_millis(ms)), input.allowed_tools, cx, ) { Ok(subagent) => subagent, Err(err) => return Task::ready(Err(err)), }; let subagent_session_id = subagent.id(); event_stream.subagent_spawned(subagent_session_id.clone()); let meta = acp::Meta::from_iter([( SUBAGENT_SESSION_ID_META_KEY.into(), subagent_session_id.to_string().into(), )]); event_stream.update_fields_with_meta(acp::ToolCallUpdateFields::new(), Some(meta)); cx.spawn(async move |cx| { let summary_task = subagent.wait_for_summary(input.summary_prompt, cx); futures::select_biased! { summary = summary_task.fuse() => summary.map(|summary| SubagentToolOutput { summary, subagent_session_id, }), _ = event_stream.cancelled_by_user().fuse() => { Err(anyhow!("Subagent was cancelled by user")) } } }) } fn replay( &self, _input: Self::Input, output: Self::Output, event_stream: ToolCallEventStream, _cx: &mut App, ) -> Result<()> { event_stream.subagent_spawned(output.subagent_session_id.clone()); let meta = acp::Meta::from_iter([( SUBAGENT_SESSION_ID_META_KEY.into(), output.subagent_session_id.to_string().into(), )]); event_stream.update_fields_with_meta(acp::ToolCallUpdateFields::new(), Some(meta)); Ok(()) } } #[cfg(test)] mod tests { use super::*; use crate::{ContextServerRegistry, Templates, Thread}; use fs::FakeFs; use gpui::{AppContext as _, TestAppContext}; use project::Project; use prompt_store::ProjectContext; use serde_json::json; use settings::SettingsStore; use util::path; async fn create_thread_with_tools(cx: &mut TestAppContext) -> Entity { cx.update(|cx| { let settings_store = SettingsStore::test(cx); cx.set_global(settings_store); }); let fs = FakeFs::new(cx.executor()); fs.insert_tree(path!("/test"), json!({})).await; let project = Project::test(fs, [path!("/test").as_ref()], cx).await; let project_context = cx.new(|_cx| ProjectContext::default()); let context_server_store = project.read_with(cx, |project, _| project.context_server_store()); let context_server_registry = cx.new(|cx| ContextServerRegistry::new(context_server_store.clone(), cx)); cx.new(|cx| { let mut thread = Thread::new( project, project_context, context_server_registry, Templates::new(), None, cx, ); thread.add_tool(crate::NowTool, None); thread.add_tool(crate::WebSearchTool, None); thread }) } #[gpui::test] async fn test_validate_allowed_tools_succeeds_for_valid_tools(cx: &mut TestAppContext) { let thread = create_thread_with_tools(cx).await; cx.update(|cx| { assert!(SubagentTool::validate_allowed_tools(&None, &thread, cx).is_ok()); let valid_tools = Some(vec!["now".to_string()]); assert!(SubagentTool::validate_allowed_tools(&valid_tools, &thread, cx).is_ok()); let both_tools = Some(vec!["now".to_string(), "web_search".to_string()]); assert!(SubagentTool::validate_allowed_tools(&both_tools, &thread, cx).is_ok()); }); } #[gpui::test] async fn test_validate_allowed_tools_fails_for_unknown_tools(cx: &mut TestAppContext) { let thread = create_thread_with_tools(cx).await; cx.update(|cx| { let unknown_tools = Some(vec!["nonexistent_tool".to_string()]); let result = SubagentTool::validate_allowed_tools(&unknown_tools, &thread, cx); assert!(result.is_err()); let error_message = result.unwrap_err().to_string(); assert!( error_message.contains("'nonexistent_tool'"), "Expected error to mention the invalid tool name, got: {error_message}" ); let mixed_tools = Some(vec![ "now".to_string(), "fake_tool_a".to_string(), "fake_tool_b".to_string(), ]); let result = SubagentTool::validate_allowed_tools(&mixed_tools, &thread, cx); assert!(result.is_err()); let error_message = result.unwrap_err().to_string(); assert!( error_message.contains("'fake_tool_a'") && error_message.contains("'fake_tool_b'"), "Expected error to mention both invalid tool names, got: {error_message}" ); assert!( !error_message.contains("'now'"), "Expected error to not mention valid tool 'now', got: {error_message}" ); }); } }