Skip to content

Support embedding resource contents in prompts #34

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

Merged
jspahrsummers merged 3 commits into from
Nov 5, 2024
Merged

Support embedding resource contents in prompts #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
430ab13
Allow prompts to embed resources
jspahrsummers Nov 4, 2024
685198f
Update prompts doc page
jspahrsummers Nov 4, 2024
6747d28
Add "type": "resource" key
jspahrsummers Nov 4, 2024
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
22 changes: 21 additions & 1 deletion docs/spec/prompts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ A Prompt in the Model Context Protocol (MCP) represents a pre-defined set of mes

Prompt Templates are prompts that can be dynamically generated or customized based on provided arguments. They allow servers to expose a flexible set of prompts that can be tailored to specific use cases. Clients can use these templates by providing the required arguments when retrieving the prompt.

### Embedded Resource Contents

Prompts can include embedded resource contents from the MCP server. This allows servers to provide context-rich prompts that incorporate relevant data or files directly into the prompt structure.

## Use Cases

Common use cases for prompts include providing standardized instructions for code reviews, data analysis tasks, or creative writing exercises. Here are examples of kinds of prompts that an MCP server could expose:
Expand Down Expand Up @@ -222,7 +226,7 @@ Example:
The server MUST respond with a `GetPromptResult` containing:

- `description`: An optional string describing the prompt
- `messages`: An array of `SamplingMessage` objects representing the prompt content
- `messages`: An array of `PromptMessage` objects representing the prompt content, which may include embedded resource contents

Example:
```json
Expand All @@ -245,6 +249,22 @@ Example:
"type": "text",
"text": "Certainly! I'd be happy to review the Python code snippet and provide feedback on its quality and potential improvements. Let's analyze it:"
}
},
{
"role": "user",
"content": {
"type": "resource",
"uri": "file:///workspace/project/requirements.txt",
"mimeType": "text/plain",
"text": "flask==2.0.1\nnumpy==1.21.0\npandas==1.3.0\n"
}
},
{
"role": "assistant",
"content": {
"type": "text",
"text": "I see you've also provided the contents of the requirements.txt file. This gives us additional context about the project environment. Let's consider these dependencies in our code review as well."
}
}
]
}
Expand Down
55 changes: 54 additions & 1 deletion schema/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@
},
"messages": {
"items": {
"$ref": "#/definitions/SamplingMessage"
"$ref": "#/definitions/PromptMessage"
},
"type": "array"
}
Expand Down Expand Up @@ -1166,6 +1166,36 @@
],
"type": "object"
},
"PromptMessage": {
"description": "Describes a message returned as part of a prompt.\n\nThis is similar to `SamplingMessage`, but also supports the embedding of\nresource contents from the MCP server.",
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/definitions/TextContent"
},
{
"$ref": "#/definitions/ImageContent"
},
{
"$ref": "#/definitions/PromptResourceContents"
}
]
},
"role": {
"enum": [
"assistant",
"user"
],
"type": "string"
}
},
"required": [
"content",
"role"
],
"type": "object"
},
"PromptReference": {
"description": "Identifies a prompt.",
"properties": {
Expand All @@ -1184,6 +1214,29 @@
],
"type": "object"
},
"PromptResourceContents": {
"description": "The contents of a resource, embedded into a prompt.\n\nIt is up to the client how best to render embedded resources for the benefit\nof the LLM and/or the user.",
"properties": {
"mimeType": {
"description": "The MIME type of this resource, if known.",
"type": "string"
},
"type": {
"const": "resource",
"type": "string"
},
"uri": {
"description": "The URI of this resource.",
"format": "uri",
"type": "string"
}
},
"required": [
"type",
"uri"
],
"type": "object"
},
"ReadResourceRequest": {
"description": "Sent from the client to the server, to read a specific resource URI.",
"properties": {
Expand Down
31 changes: 26 additions & 5 deletions schema/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,6 @@ export interface ClientCapabilities {
* Experimental, non-standard capabilities that the client supports.
*/
experimental?: { [key: string]: object };
/**
* Present if the client supports sampling from an LLM.
*/
sampling?: object;
/**
* Present if the client supports listing roots.
*/
Expand All @@ -170,6 +166,10 @@ export interface ClientCapabilities {
*/
listChanged?: boolean;
};
/**
* Present if the client supports sampling from an LLM.
*/
sampling?: object;
}

/**
Expand Down Expand Up @@ -515,7 +515,7 @@ export interface GetPromptResult extends Result {
* An optional description for the prompt.
*/
description?: string;
messages: SamplingMessage[];
messages: PromptMessage[];
}

/**
Expand Down Expand Up @@ -554,6 +554,27 @@ export interface PromptArgument {
required?: boolean;
}

/**
* Describes a message returned as part of a prompt.
*
* This is similar to `SamplingMessage`, but also supports the embedding of
* resource contents from the MCP server.
*/
export interface PromptMessage {
role: "user" | "assistant";
content: TextContent | ImageContent | PromptResourceContents;
}

/**
* The contents of a resource, embedded into a prompt.
*
* It is up to the client how best to render embedded resources for the benefit
* of the LLM and/or the user.
*/
export interface PromptResourceContents extends ResourceContents {
type: "resource";
}

Comment on lines +568 to +577

@dsp-ant dsp-ant Nov 5, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. So we are still referencing an actual resource. When you said "embedded" I originally thought you meant directly returning bytes/strings here.

@jspahrsummers jspahrsummers Nov 5, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does directly return bytes/strings—that comes from extending ResourceContents. This is just a type tag.

@jspahrsummers jspahrsummers Nov 5, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yeah, this is a bit confusing. Follow-up: #36

/**
* An optional notification from the server to the client, informing it that the list of prompts it offers has changed. This may be issued by servers without any previous subscription from the client.
*/
Expand Down