Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update instructions #557

Merged
merged 2 commits into from
Jan 8, 2025
Merged

fix: update instructions #557

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ac5774
Update instruction prompts
salman1993 Jan 8, 2025
9b4e138
Fix typos
salman1993 Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 89 additions & 16 deletions crates/goose-mcp/src/developer/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ mod process_store;

use anyhow::Result;
use base64::Engine;
use indoc::formatdoc;
use indoc::{formatdoc, indoc};
use serde_json::{json, Value};
use std::{
collections::HashMap,
Expand Down Expand Up @@ -52,39 +52,81 @@ impl Default for DeveloperRouter {
impl DeveloperRouter {
pub fn new() -> Self {
let bash_tool = Tool::new(
"bash".to_string(),
"Run a bash command in the shell in the current working directory".to_string(),
"bash",
indoc! {r#"
Run a bash command in the shell in the current working directory
- You can use multiline commands or && to execute multiple in one pass
- Directory changes **are not** persisted from one command to the next
- Sourcing files **is not** persisted from one command to the next

For example, you can use this style to execute python in a virtualenv
"source .venv/bin/active && python example1.py"

but need to repeat the source for subsequent commands in that virtualenv
"source .venv/bin/active && python example2.py"
"#},
json!({
"type": "object",
"required": ["command"],
"properties": {
"command": {"type": "string"}
"command": {
"type": "string",
"default": null,
"description": "The bash shell command to run."
},
}
}),
);

let text_editor_tool = Tool::new(
"text_editor".to_string(),
"Perform text editing operations on files.".to_string(),
"text_editor",
indoc! {r#"
Perform text editing operations on files.

The `command` parameter specifies the operation to perform. Allowed options are:
- `view`: View the content of a file.
- `write`: Write a file with the given content (create a new file or overwrite an existing).
- `str_replace`: Replace a string in a file with a new string.
- `undo_edit`: Undo the last edit made to a file.
"#},
json!({
"type": "object",
"required": ["command", "path"],
"properties": {
"path": {"type": "string"},
"path": {
"type": "string",
"description": "Path to the file. Can be absolute or relative to the system CWD"
},
"command": {
"enum": ["view", "write", "str_replace", "undo_edit"],
"description": "The command to run."
},
"new_str": {
"type": "string",
"enum": ["view", "write", "str_replace", "undo_edit"]
"default": null,
"description": "Required for the `str_replace` command."
},
"old_str": {
"type": "string",
"default": null,
"description": "Required for the `str_replace` command."
},
"file_text": {
"type": "string",
"default": null,
"description": "Required for `write` command."
},
"new_str": {"type": "string"},
"old_str": {"type": "string"},
"file_text": {"type": "string"}
}
}),
);

let list_windows_tool = Tool::new(
"list_windows".to_string(),
"List all open windows".to_string(),
"list_windows",
indoc! {r#"
List all available window titles that can be used with screen_capture.
Returns a list of window titles that can be used with the window_title parameter
of the screen_capture tool.
"#},
json!({
"type": "object",
"required": [],
Expand All @@ -93,8 +135,15 @@ impl DeveloperRouter {
);

let screen_capture_tool = Tool::new(
"screen_capture".to_string(),
"Capture a screenshot of a specified display or window.\nYou can capture either:\n1. A full display (monitor) using the display parameter\n2. A specific window by its title using the window_title parameter\n\nOnly one of display or window_title should be specified.".to_string(),
"screen_capture",
indoc! {r#"
Capture a screenshot of a specified display or window.
You can capture either:
1. A full display (monitor) using the display parameter
2. A specific window by its title using the window_title parameter

Only one of display or window_title should be specified.
"#},
json!({
"type": "object",
"required": [],
Expand All @@ -113,7 +162,31 @@ impl DeveloperRouter {
}),
);

let instructions = "Developer instructions...".to_string(); // Reuse from original code
let instructions = formatdoc! {r#"
The developer system is loaded in the directory listed below.
You can use the shell tool to run any command that would work on the relevant operating system.
Use the shell tool as needed to locate files or interact with the project. Only files
that have been read or modified using the edit tools will show up in the active files list.

bash
- Prefer ripgrep - `rg` - when you need to locate content, it will respected ignored files for
efficiency. **Avoid find and ls -r**
- to locate files by name: `rg --files | rg example.py`
- to locate consent inside files: `rg 'class Example'`
- The operating system for these commands is {os}


text_edit
- Always use 'view' command first before any edit operations
- File edits are tracked and can be undone with 'undo'
- String replacements must match exactly once in the file
- Line numbers start at 1 for insert operations

The write mode will do a full overwrite of the existing file, while the str_replace mode will edit it
using a find and replace. Choose the mode which will make the edit as simple as possible to execute.
"#,
os=std::env::consts::OS,
};

let cwd = std::env::current_dir().unwrap();
let mut resources = HashMap::new();
Expand Down
Loading