Thanks to visit codestin.com
Credit goes to github.com

Skip to content

add ResourceLink to CallToolResult #603

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
bhosmer-ant merged 13 commits into from
Jun 10, 2025
Merged

add ResourceLink to CallToolResult #603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ace8816
add ResourceReference to CallToolResult
bhosmer-ant May 30, 2025
307ab83
Include a discriminated LinkedResource for embedding Resources in Too…
evalstate Jun 4, 2025
4641c3e
preparing documentation updates
evalstate Jun 4, 2025
22e8b33
changed ordering, rerun schema gen
evalstate Jun 4, 2025
1d3f8a4
Include a discriminated LinkedResource for embedding Resources in Too…
evalstate Jun 4, 2025
f156eb7
preparing documentation updates
evalstate Jun 4, 2025
e8568dd
update to is-a rather than contains-a relationship for linked resource.
evalstate Jun 5, 2025
5867635
add docs
bhosmer-ant Jun 5, 2025
b88a807
generate schema.json
bhosmer-ant Jun 5, 2025
2559ad4
update schema.ts comment
bhosmer-ant Jun 5, 2025
70868f9
rebase, format
bhosmer-ant Jun 5, 2025
4e6e4c6
fix changelog link
bhosmer-ant Jun 10, 2025
bfbd362
LinkedResource -> ResourceLink
bhosmer-ant Jun 10, 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
2 changes: 2 additions & 0 deletions docs/specification/draft/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ the previous revision, [2025-03-26](/specification/2025-03-26).
5. Added support for **[elicitation](client/elicitation)**, enabling servers to request additional
information from users during interactions.
(PR [#382](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/382))
6. Added support for **[resource links](/specification/draft/server/tools#resource-links)** in
tool call results. (PR [#603](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/603))

## Other schema changes

Expand Down
30 changes: 25 additions & 5 deletions docs/specification/draft/server/tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,18 +230,38 @@ Tool results may contain [**structured**](#structured-content) or **unstructured
}
```

#### Resource Links

A tool **MAY** return links to [Resources](/specification/draft/server/resources), to provide additional context
or data. In this case, the tool will return a URI that can be subscribed to or fetched by the client:

```json
{
"type": "resource_link",
"uri": "file:///project/src/main.rs",
"name": "main.rs",
"description": "Primary application entry point",
"mimeType": "text/x-rust"
}
```

<Info>
Resource links returned by tools are not guaranteed to appear in the results
of a `resources/list` request.
</Info>

#### Embedded Resources

[Resources](/specification/draft/server/resources) **MAY** be embedded, to provide additional context
or data, behind a URI that can be subscribed to or fetched again by the client later:
A tool **MAY** return embedded [Resource contents](/specification/draft/server/resources), to provide additional context
or data, along with a URI that can be subscribed to or fetched again by the client later:

```json
{
"type": "resource",
"resource": {
"uri": "resource://example",
"mimeType": "text/plain",
"text": "Resource content"
"uri": "file:///project/src/main.rs",
"mimeType": "text/x-rust",
"text": "fn main() {\n println!(\"Hello world!\");\n}"
}
}
```
Expand Down
89 changes: 61 additions & 28 deletions schema/draft/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 25 additions & 5 deletions schema/draft/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,16 @@ export type Role = "user" | "assistant";
*/
export interface PromptMessage {
role: Role;
content: TextContent | ImageContent | AudioContent | EmbeddedResource;
content: ContentBlock;
Copy link
Member

@evalstate evalstate Jun 4, 2025

Choose a reason for hiding this comment

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

This would be a good time to merge turns this in to an Array similar to the existing ToolCallResult.

Copy link
Contributor Author

@bhosmer-ant bhosmer-ant Jun 4, 2025

Choose a reason for hiding this comment

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

Took a quick look at that discussion, seems well motivated to me but I think best to keep it a separate PR

}

/**
* A resource that the server is capable of reading, included in a prompt or tool call result.
*
* Note: resource links returned by tools are not guaranteed to appear in the results of `resources/list` requests.
*/
export interface ResourceLink extends Resource {
type: "resource_link";
}

/**
Expand All @@ -652,7 +661,6 @@ export interface EmbeddedResource {
*/
annotations?: Annotations;
}

/**
* 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 Expand Up @@ -682,7 +690,7 @@ export interface CallToolResult extends Result {
/**
* A list of content objects that represent the unstructured result of the tool call.
*/
content: (TextContent | ImageContent | AudioContent | EmbeddedResource)[];
content: ContentBlock[];

/**
* An optional JSON object that represents the structured result of the tool call.
Expand Down Expand Up @@ -953,6 +961,14 @@ export interface Annotations {
priority?: number;
}

/** */
export type ContentBlock =
| TextContent
| ImageContent
| AudioContent
| ResourceLink
| EmbeddedResource;

/**
* Text provided to or from an LLM.
*/
Expand Down Expand Up @@ -1291,7 +1307,7 @@ export interface EnumSchema {
title?: string;
description?: string;
enum: string[];
enumNames?: string[]; // Display names for enum values
enumNames?: string[]; // Display names for enum values
}

/**
Expand Down Expand Up @@ -1335,7 +1351,11 @@ export type ClientNotification =
| InitializedNotification
| RootsListChangedNotification;

export type ClientResult = EmptyResult | CreateMessageResult | ListRootsResult | ElicitResult;
export type ClientResult =
| EmptyResult
| CreateMessageResult
| ListRootsResult
| ElicitResult;

/* Server messages */
export type ServerRequest =
Expand Down