pub mod edit; pub mod shell; pub mod tree; use crate::agents::extension::PlatformExtensionContext; use crate::agents::mcp_client::{Error, McpClientTrait}; use crate::agents::ToolCallContext; use anyhow::Result; use async_trait::async_trait; use edit::{EditTools, FileEditParams, FileWriteParams}; use indoc::indoc; use rmcp::model::{ CallToolResult, Content, Implementation, InitializeResult, JsonObject, ListToolsResult, ServerCapabilities, Tool, ToolAnnotations, }; use schemars::{schema_for, JsonSchema}; use serde_json::Value; use shell::{shell_display_name, ShellOutput, ShellParams, ShellTool}; use std::sync::Arc; use tokio_util::sync::CancellationToken; use tree::{TreeParams, TreeTool}; pub static EXTENSION_NAME: &str = "developer"; pub struct DeveloperClient { info: InitializeResult, shell_tool: Arc, edit_tools: Arc, tree_tool: Arc, } fn developer_instructions() -> &'static str { if cfg!(windows) { indoc! {" Use the developer extension to build software and operate a terminal. Make sure to use the tools *efficiently* - reading all the content you need in as few iterations as possible and then making the requested edits or running commands. You are responsible for managing your context window, and to minimize unnecessary turns which cost the user money. For editing software, prefer the flow of using tree to understand the codebase structure and file sizes. When you need to search, prefer findstr or Select-String (via shell). Then use type or Get-Content to gather the context you need, always reading before editing. Use write and edit to efficiently make changes. Test and verify as appropriate. "} } else { indoc! {" Use the developer extension to build software and operate a terminal. Make sure to use the tools *efficiently* - reading all the content you need in as few iterations as possible and then making the requested edits or running commands. You are responsible for managing your context window, and to minimize unnecessary turns which cost the user money. For editing software, prefer the flow of using tree to understand the codebase structure and file sizes. When you need to search, prefer rg which correctly respects gitignored content. Then use cat or sed to gather the context you need, always reading before editing. Use write and edit to efficiently make changes. Test and verify as appropriate. "} } } impl DeveloperClient { pub fn new(_context: PlatformExtensionContext) -> Result { let info = InitializeResult::new(ServerCapabilities::builder().enable_tools().build()) .with_server_info(Implementation::new(EXTENSION_NAME, "1.0.0").with_title("Developer")) .with_instructions(developer_instructions()); Ok(Self { info, shell_tool: Arc::new(ShellTool::new()?), edit_tools: Arc::new(EditTools::new()), tree_tool: Arc::new(TreeTool::new()), }) } fn schema() -> JsonObject { serde_json::to_value(schema_for!(T)) .expect("schema serialization should succeed") .as_object() .expect("schema should serialize to an object") .clone() } pub fn parse_args( arguments: Option, ) -> Result { let value = arguments .map(Value::Object) .ok_or_else(|| "Missing arguments".to_string())?; serde_json::from_value(value).map_err(|e| format!("Failed to parse arguments: {e}")) } pub(crate) fn get_tools() -> Vec { vec![ Tool::new( "write".to_string(), "Create a new file or overwrite an existing file. Creates parent directories if needed.".to_string(), Self::schema::(), ) .annotate(ToolAnnotations::from_raw( Some("Write".to_string()), Some(false), Some(true), Some(false), Some(false), )), Tool::new( "edit".to_string(), "Edit a file by finding and replacing text. The before text must match exactly and uniquely. Use empty after text to delete.".to_string(), Self::schema::(), ) .annotate(ToolAnnotations::from_raw( Some("Edit".to_string()), Some(false), Some(true), Some(false), Some(false), )), Tool::new( "shell".to_string(), format!( "Execute a shell command in the current dir. Commands run under `{shell}` \ (set GOOSE_SHELL to override) - write command strings in that shell's \ syntax. Returns an object with stdout and stderr as separate fields. The \ output of each stream is limited to up to 2000 lines, and longer outputs \ will be saved to a temporary file.", shell = shell_display_name(), ), Self::schema::(), ) .with_output_schema::() .annotate(ToolAnnotations::from_raw( Some("Shell".to_string()), Some(false), Some(true), Some(false), Some(true), )), Tool::new( "tree".to_string(), "List a directory tree with line counts. Traversal respects .gitignore rules.".to_string(), Self::schema::(), ) .annotate(ToolAnnotations::from_raw( Some("Tree".to_string()), Some(true), Some(false), Some(true), Some(false), )), ] } } #[async_trait] impl McpClientTrait for DeveloperClient { async fn list_tools( &self, _session_id: &str, _next_cursor: Option, _cancellation_token: CancellationToken, ) -> Result { Ok(ListToolsResult { tools: Self::get_tools(), next_cursor: None, meta: None, }) } async fn call_tool( &self, ctx: &ToolCallContext, name: &str, arguments: Option, _cancel_token: CancellationToken, ) -> Result { let working_dir = ctx.working_dir.as_deref(); match name { "shell" => match Self::parse_args::(arguments) { Ok(params) => Ok(self.shell_tool.shell_with_cwd(params, working_dir).await), Err(error) => Ok(ShellTool::error_result(&format!("Error: {error}"), None)), }, "write" => match Self::parse_args::(arguments) { Ok(params) => Ok(self.edit_tools.file_write_with_cwd(params, working_dir)), Err(error) => Ok(CallToolResult::error(vec![Content::text(format!( "Error: {error}" )) .with_priority(0.0)])), }, "edit" => match Self::parse_args::(arguments) { Ok(params) => Ok(self.edit_tools.file_edit_with_cwd(params, working_dir)), Err(error) => Ok(CallToolResult::error(vec![Content::text(format!( "Error: {error}" )) .with_priority(0.0)])), }, "tree" => match Self::parse_args::(arguments) { Ok(params) => Ok(self.tree_tool.tree_with_cwd(params, working_dir)), Err(error) => Ok(CallToolResult::error(vec![Content::text(format!( "Error: {error}" )) .with_priority(0.0)])), }, _ => Ok(CallToolResult::error(vec![Content::text(format!( "Error: Unknown tool: {name}" )) .with_priority(0.0)])), } } fn get_info(&self) -> Option<&InitializeResult> { Some(&self.info) } } #[cfg(test)] mod tests { use super::*; use crate::session::SessionManager; use rmcp::model::RawContent; use rmcp::object; use std::fs; #[test] fn developer_tools_are_flat() { let names: Vec = DeveloperClient::get_tools() .into_iter() .map(|t| t.name.to_string()) .collect(); assert_eq!(names, vec!["write", "edit", "shell", "tree"]); } fn test_context(data_dir: std::path::PathBuf) -> PlatformExtensionContext { PlatformExtensionContext { extension_manager: None, session_manager: Arc::new(SessionManager::new(data_dir)), session: None, } } fn first_text(result: &CallToolResult) -> &str { match &result.content[0].raw { RawContent::Text(text) => &text.text, _ => panic!("expected text content"), } } #[tokio::test] async fn developer_client_uses_working_dir_for_file_tools() { let temp = tempfile::tempdir().unwrap(); let client = DeveloperClient::new(test_context(temp.path().join("sessions"))).unwrap(); let cwd = temp.path().join("workspace"); fs::create_dir_all(&cwd).unwrap(); let ctx = ToolCallContext::new("session".to_owned(), Some(cwd.clone()), None); let write = client .call_tool( &ctx, "write", Some(object!({ "path": "notes.txt", "content": "first line" })), CancellationToken::new(), ) .await .unwrap(); assert_eq!(write.is_error, Some(false)); assert_eq!( fs::read_to_string(cwd.join("notes.txt")).unwrap(), "first line" ); let edit = client .call_tool( &ctx, "edit", Some(object!({ "path": "notes.txt", "before": "first", "after": "updated" })), CancellationToken::new(), ) .await .unwrap(); assert_eq!(edit.is_error, Some(false)); assert_eq!( fs::read_to_string(cwd.join("notes.txt")).unwrap(), "updated line" ); } #[cfg(not(windows))] #[tokio::test] async fn developer_client_uses_working_dir_for_shell_tool() { let temp = tempfile::tempdir().unwrap(); let client = DeveloperClient::new(test_context(temp.path().join("sessions"))).unwrap(); let cwd = temp.path().join("workspace"); fs::create_dir_all(&cwd).unwrap(); let ctx = ToolCallContext::new("session".to_owned(), Some(cwd.clone()), None); let result = client .call_tool( &ctx, "shell", Some(object!({ "command": "pwd" })), CancellationToken::new(), ) .await .unwrap(); assert_eq!(result.is_error, Some(false)); let observed = std::fs::canonicalize(first_text(&result)).unwrap(); let expected = std::fs::canonicalize(&cwd).unwrap(); assert_eq!(observed, expected); } }