feat: mcp server prompts #562

wendytang · 2025-01-08T21:58:28Z

What are prompts?
The Model Context Protocol (MCP) provides a standardized way for servers to expose prompt templates to clients. Prompts allow servers to provide structured messages and instructions for interacting with language models. Clients can discover available prompts, retrieve their contents, and provide arguments to customize them.

What does a prompt look like?
This is an example unit_test text prompt endpoint from the mcp inspector. For the unit test prompt, users can input the code file and language as a parameter and generate a templated prompt

npx @modelcontextprotocol/inspector cargo run --bin goose mcp developer

What is the UI/UX going to look like?
MCP really leaves it up to the implementer to decide on how to surface prompts. For inspiration, they suggest a slash command, but it could be anything from a dropdown list or a list of templates.

Implementation details:

(todo) list_prompts requires pagination
image and resource prompt data types supported, would need to find a way to provide that via gui
list change notifications

github-actions · 2025-01-10T01:12:17Z

Desktop App for this PR

The following build is available for testing:

📱 macOS Desktop App (Universal, signed)

The app is signed and notarized for macOS. After downloading, unzip the file and drag the Goose.app to your Applications folder.

This link is provided by nightly.link and will work even if you're not logged into GitHub.

github-actions · 2025-01-10T18:53:43Z

Desktop App for this PR

The following build is available for testing:

📱 macOS Desktop App (Universal, signed)

The app is signed and notarized for macOS. After downloading, unzip the file and drag the Goose.app to your Applications folder.

This link is provided by nightly.link and will work even if you're not logged into GitHub.

github-actions · 2025-01-10T21:51:15Z

Desktop App for this PR

The following build is available for testing:

📱 macOS Desktop App (Universal, signed)

The app is signed and notarized for macOS. After downloading, unzip the file and drag the Goose.app to your Applications folder.

This link is provided by nightly.link and will work even if you're not logged into GitHub.

github-actions · 2025-01-10T22:08:16Z

Desktop App for this PR

The following build is available for testing:

📱 macOS Desktop App (Universal, signed)

The app is signed and notarized for macOS. After downloading, unzip the file and drag the Goose.app to your Applications folder.

This link is provided by nightly.link and will work even if you're not logged into GitHub.

wendytang · 2025-01-10T22:31:54Z

crates/mcp-core/src/content.rs

@@ -53,7 +53,7 @@ pub struct ImageContent {
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct EmbeddedResource {
-    resource: ResourceContents,
+    pub resource: ResourceContents,


@baxen any concerns with having resource as a publicly accessible field?

where is this getting used? trying to understand why this needs to be public

this is more like a nice to have, right now we only support text prompts, but this allows for adding resource and images in the context - https://spec.modelcontextprotocol.io/specification/2024-11-05/server/prompts/#embedded-resources

seems fine to me

crates/mcp-server/src/router.rs

salman1993 · 2025-01-12T23:58:35Z

crates/mcp-server/src/router.rs

@@ -93,6 +94,15 @@ pub trait Router: Send + Sync + 'static {
        &self,
        uri: &str,
    ) -> Pin<Box<dyn Future<Output = Result<String, ResourceError>> + Send + 'static>>;
+    fn list_prompts(&self) -> Option<Vec<Prompt>> {


i think you'll need to add these methods on mcp-client to make it work with goose. it can be a separate PR. we can use the passthrough method to send request to a system

goose/crates/goose/src/agents/agent.rs

Line 27 in bcd991c

async fn passthrough(&self, system: &str, request: Value) -> SystemResult<Value>;

the method needs to be implemented for the default agent:

goose/crates/goose/src/agents/default.rs

Line 147 in bcd991c

async fn passthrough(&self, _system: &str, _request: Value) -> SystemResult<Value> {

@salman1993 could you elaborate on the need to handle on client-side? my understanding was that prompts would belong in servers and handled by add_systems

goose/crates/goose-cli/src/commands/session.rs

Line 68 in bcd991c

.add_system(config)

you'd have to add the prompt methods here - it gets used by goose agent here

each MCP client has a 1:1 relationship with a server

crates/mcp-server/src/errors.rs

crates/goose-mcp/src/developer/developer_prompt.rs

salman1993 · 2025-01-13T01:00:27Z

crates/mcp-core/src/prompt.rs

+    }
+
+    /// Create a new resource message
+    pub fn new_resource(


how does this get used?

It is just implemented, not used at the moment. For supporting image and resource in prompt - https://spec.modelcontextprotocol.io/specification/2024-11-05/server/prompts/#embedded-resources

salman1993 · 2025-01-13T01:03:28Z

crates/goose-mcp/src/developer/mod.rs

@@ -162,6 +165,8 @@ impl DeveloperRouter {
            }),
        );

+        let unit_test_prompt = developer_prompt::create_unit_test_prompt();


@baxen is it okay to have the unit test gen prompt in the developer system? conceptually it makes sense to me

Seems ok to me. At first I thought it could make sense more as its own unit test specific server, but it's germane enough to the work of general software development I think adding it makes sense.

yeah seems good! i think very little harm in having prompts around as they only get used when requested

github-actions · 2025-01-13T21:55:04Z

Desktop App for this PR

The following build is available for testing:

📱 macOS Desktop App (Universal, signed)

The app is signed and notarized for macOS. After downloading, unzip the file and drag the Goose.app to your Applications folder.

This link is provided by nightly.link and will work even if you're not logged into GitHub.

salman1993 · 2025-01-14T02:38:59Z

crates/mcp-server/src/router.rs

+                .await
+                .map_err(|e| RouterError::Internal(e.to_string()))?;
+
+            // Validate prompt arguments for potential security issues


how did you come up with these validation rules?

alexhancock · 2025-01-14T02:34:50Z

crates/goose-mcp/src/developer/mod.rs

@@ -162,6 +165,8 @@ impl DeveloperRouter {
            }),
        );

+        let unit_test_prompt = developer_prompt::create_unit_test_prompt();


Seems ok to me. At first I thought it could make sense more as its own unit test specific server, but it's germane enough to the work of general software development I think adding it makes sense.

alexhancock · 2025-01-14T02:54:26Z

crates/mcp-core/src/prompt.rs

+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct PromptArgumentTemplate {


I get a little lost in the implementation of these prompt/argument templates. Don't we need the type information somewhere for what types the arguments can be?

Yeah it's a bit confusing, but for prompt arguments, they're all going to be strings - eg the code argument

{ "jsonrpc": "2.0", "id": 1, "result": { "prompts": [ { "name": "code_review", "description": "Asks the LLM to analyze code quality and suggest improvements", "arguments": [ { "name": "code", "description": "The code to review", "required": true } ] } ], "nextCursor": "next-page-cursor" } }

baxen

Looks great!

baxen · 2025-01-14T05:49:24Z

crates/mcp-core/src/content.rs

@@ -53,7 +53,7 @@ pub struct ImageContent {
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct EmbeddedResource {
-    resource: ResourceContents,
+    pub resource: ResourceContents,


seems fine to me

baxen · 2025-01-14T05:53:39Z

crates/mcp-server/src/router.rs

+    fn get_prompt(
+        &self,
+        _prompt_name: &str,
+    ) -> Option<Pin<Box<dyn Future<Output = Result<String, PromptError>> + Send + 'static>>> {


nit: i'd remove the option here and leave these unimplemented for consistency? I suspect these are here so we don't break the existing servers, but i think we can go fix those up

baxen · 2025-01-14T05:55:54Z

crates/goose-mcp/src/developer/mod.rs

@@ -162,6 +165,8 @@ impl DeveloperRouter {
            }),
        );

+        let unit_test_prompt = developer_prompt::create_unit_test_prompt();


yeah seems good! i think very little harm in having prompts around as they only get used when requested

crates/goose-mcp/src/developer/mod.rs

baxen · 2025-01-14T05:57:29Z

crates/goose-mcp/src/developer/mod.rs

+        let prompts = self.prompts.clone();
+
+        Some(Box::pin(async move {
+            // Check if prompts list is empty


nit: this isn't reachable right?

crates/goose-mcp/src/developer/developer_prompt.rs

github-actions · 2025-01-14T20:29:21Z

Desktop App for this PR

The following build is available for testing:

📱 macOS Desktop App (Universal, signed)

The app is signed and notarized for macOS. After downloading, unzip the file and drag the Goose.app to your Applications folder.

This link is provided by nightly.link and will work even if you're not logged into GitHub.

* ldelalande/welcome-ux-update: (42 commits) format Use new configuration and secret storage Simplify configuration (#607) [setup] UX simplification for adding API keys on app startup adding in comments for where to add variables for bundling can reset the provider will open new window when set show window based on local storage goose_provider update the icon new goose modals for adding models latest changes with mock keystore initial static setup fix: update BufReader capacity to 2MB (#605) fix: escape double quotes in error part (#602) refactor: remove unused errors in mcp-client (#598) add more context from mcp server errors (#599) fix: error formatting for vercel data format (#597) feat: Add endpoint to store secrets in keychain (#595) feat: mcp server prompts (#562) fix: Temporarily disable moderation (#594) ...

wendytang added 3 commits January 7, 2025 15:52

initial prompts implementation

ad76794

use unit_test to generate prompt

b2516c0

Merge branch 'v1.0' into wtang/server_prompt

56e3535

wendytang changed the title ~~Wtang/server prompt~~ feat: server prompts Jan 10, 2025

implement text prompts

1aef36f

wendytang changed the title ~~feat: server prompts~~ feat: mcp server prompts Jan 10, 2025

base64

a195a57

fmt

ef6e675

add json file, jsonschema generation

dca74cc

wendytang commented Jan 10, 2025

View reviewed changes

wendytang marked this pull request as ready for review January 10, 2025 22:32

wendytang requested review from alexhancock, salman1993, baxen and michaelneale January 10, 2025 22:37

kalvinnchau reviewed Jan 10, 2025

View reviewed changes

crates/mcp-server/src/router.rs Outdated Show resolved Hide resolved

salman1993 reviewed Jan 12, 2025

View reviewed changes

salman1993 reviewed Jan 13, 2025

View reviewed changes

crates/mcp-server/src/errors.rs Outdated Show resolved Hide resolved

salman1993 reviewed Jan 13, 2025

View reviewed changes

crates/goose-mcp/src/developer/developer_prompt.rs Outdated Show resolved Hide resolved

salman1993 reviewed Jan 13, 2025

View reviewed changes

use existing content obj, fmt

0477f7a

wendytang force-pushed the wtang/server_prompt branch from e54bd46 to 0477f7a Compare January 13, 2025 21:42

Merge branch 'v1.0' into wtang/server_prompt

95253fe

wendytang force-pushed the wtang/server_prompt branch from 83aba48 to 95253fe Compare January 13, 2025 21:44

salman1993 requested a review from lily-de January 14, 2025 02:25

salman1993 reviewed Jan 14, 2025

View reviewed changes

alexhancock reviewed Jan 14, 2025

View reviewed changes

alexhancock self-requested a review January 14, 2025 02:55

alexhancock approved these changes Jan 14, 2025

View reviewed changes

baxen approved these changes Jan 14, 2025

View reviewed changes

salman1993 approved these changes Jan 14, 2025

View reviewed changes

wendytang added 3 commits January 14, 2025 11:57

nits

e64de3a

add comments

062fcbe

fmt

e3d5aef

wendytang merged commit 3409d11 into v1.0 Jan 14, 2025
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: mcp server prompts #562

feat: mcp server prompts #562

wendytang commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 10, 2025

github-actions bot commented Jan 10, 2025

wendytang Jan 10, 2025

salman1993 Jan 13, 2025

wendytang Jan 13, 2025

baxen Jan 14, 2025

salman1993 Jan 12, 2025 •

edited

Loading

wendytang Jan 14, 2025

salman1993 Jan 14, 2025 •

edited

Loading

salman1993 Jan 13, 2025 •

edited

Loading

wendytang Jan 13, 2025

salman1993 Jan 13, 2025

alexhancock Jan 14, 2025

baxen Jan 14, 2025

github-actions bot commented Jan 13, 2025

salman1993 Jan 14, 2025 •

edited

Loading

alexhancock Jan 14, 2025

alexhancock Jan 14, 2025

wendytang Jan 14, 2025 •

edited

Loading

baxen left a comment

baxen Jan 14, 2025

baxen Jan 14, 2025

baxen Jan 14, 2025

baxen Jan 14, 2025

github-actions bot commented Jan 14, 2025

feat: mcp server prompts #562

feat: mcp server prompts #562

Conversation

wendytang commented Jan 8, 2025 • edited Loading

github-actions bot commented Jan 10, 2025

Desktop App for this PR

github-actions bot commented Jan 10, 2025

Desktop App for this PR

github-actions bot commented Jan 10, 2025

Desktop App for this PR

github-actions bot commented Jan 10, 2025

Desktop App for this PR

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

salman1993 Jan 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

salman1993 Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

salman1993 Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 13, 2025

Desktop App for this PR

salman1993 Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wendytang Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

baxen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 14, 2025

Desktop App for this PR

wendytang commented Jan 8, 2025 •

edited

Loading

salman1993 Jan 12, 2025 •

edited

Loading

salman1993 Jan 14, 2025 •

edited

Loading

salman1993 Jan 13, 2025 •

edited

Loading

salman1993 Jan 14, 2025 •

edited

Loading

wendytang Jan 14, 2025 •

edited

Loading