Skip to content

feat: Add SEP-973 icons and metadata support #912

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

Open
sainathreddyb wants to merge 1 commit into
base: main
Choose a base branch
from
+254 −17
Open

feat: Add SEP-973 icons and metadata support #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
95 changes: 85 additions & 10 deletions mcp-core/src/main/java/io/modelcontextprotocol/spec/McpSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,19 @@
import java.util.List;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

import io.modelcontextprotocol.json.McpJsonMapper;
import io.modelcontextprotocol.json.TypeRef;
import io.modelcontextprotocol.util.Assert;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* Based on the <a href="http://www.jsonrpc.org/specification">JSON-RPC 2.0
Expand Down Expand Up @@ -662,16 +664,54 @@ public ServerCapabilities build() {
* past specs or fallback (if title isn't present).
* @param title Intended for UI and end-user contexts
* @param version The version of the implementation.
* @param description An optional human-readable description of this implementation.
* @param icons An optional list of icons for this implementation.
* @param websiteUrl An optional URL of the website for this implementation.
*/
@JsonInclude(JsonInclude.Include.NON_ABSENT)
@JsonIgnoreProperties(ignoreUnknown = true)
public record Implementation( // @formatter:off
@JsonProperty("name") String name,
@JsonProperty("title") String title,
@JsonProperty("version") String version) implements Identifier { // @formatter:on
@JsonProperty("version") String version,
@JsonProperty("description") String description,
@JsonProperty("icons") List<Icon> icons,
@JsonProperty("websiteUrl") String websiteUrl) implements Identifier { // @formatter:on

public Implementation(String name, String version) {
this(name, null, version);
this(name, null, version, null, null, null);
}

public Implementation(String name, String title, String version) {
this(name, title, version, null, null, null);
}
}

/**
* Represents an icon that can be displayed in a user interface.
*
* @param src A URI pointing to an icon resource or a base64-encoded data URI.
* @param mimeType Optional MIME type override if the server's MIME type is missing or
* generic.
* @param sizes Optional array of strings specifying sizes at which the icon can be
* used. Each string should be in WxH format (e.g., "48x48", "96x96") or "any" for
* scalable formats like SVG.
* @see <a href=
* "https://github.com/modelcontextprotocol/modelcontextprotocol/issues/973">SEP-973</a>
*/
@JsonInclude(JsonInclude.Include.NON_ABSENT)
@JsonIgnoreProperties(ignoreUnknown = true)
public record Icon( // @formatter:off
@JsonProperty("src") String src,
@JsonProperty("mimeType") String mimeType,
@JsonProperty("sizes") List<String> sizes) { // @formatter:on

public Icon {
Assert.hasText(src, "Icon src must not be empty");
}

public Icon(String src, String mimeType) {
this(src, mimeType, null);
}
}

Expand Down Expand Up @@ -793,6 +833,7 @@ public record Resource( // @formatter:off
@JsonProperty("mimeType") String mimeType,
@JsonProperty("size") Long size,
@JsonProperty("annotations") Annotations annotations,
@JsonProperty("icons") List<Icon> icons,
@JsonProperty("_meta") Map<String, Object> meta) implements ResourceContent { // @formatter:on

public static Builder builder() {
Expand All @@ -815,6 +856,8 @@ public static class Builder {

private Annotations annotations;

private List<Icon> icons;

private Map<String, Object> meta;

public Builder uri(String uri) {
Expand Down Expand Up @@ -852,6 +895,11 @@ public Builder annotations(Annotations annotations) {
return this;
}

public Builder icons(List<Icon> icons) {
this.icons = icons;
return this;
}

public Builder meta(Map<String, Object> meta) {
this.meta = meta;
return this;
Expand All @@ -861,7 +909,7 @@ public Resource build() {
Assert.hasText(uri, "uri must not be empty");
Assert.hasText(name, "name must not be empty");

return new Resource(uri, name, title, description, mimeType, size, annotations, meta);
return new Resource(uri, name, title, description, mimeType, size, annotations, icons, meta);
}

}
Expand Down Expand Up @@ -894,18 +942,24 @@ public record ResourceTemplate( // @formatter:off
@JsonProperty("description") String description,
@JsonProperty("mimeType") String mimeType,
@JsonProperty("annotations") Annotations annotations,
@JsonProperty("icons") List<Icon> icons,
@JsonProperty("_meta") Map<String, Object> meta) implements Annotated, Identifier, Meta { // @formatter:on

public ResourceTemplate(String uriTemplate, String name, String title, String description, String mimeType,
Annotations annotations) {
this(uriTemplate, name, title, description, mimeType, annotations, null);
this(uriTemplate, name, title, description, mimeType, annotations, null, null);
}

public ResourceTemplate(String uriTemplate, String name, String description, String mimeType,
Annotations annotations) {
this(uriTemplate, name, null, description, mimeType, annotations);
}

public ResourceTemplate(String uriTemplate, String name, String title, String description, String mimeType,
Annotations annotations, Map<String, Object> meta) {
this(uriTemplate, name, title, description, mimeType, annotations, null, meta);
}

public static Builder builder() {
return new Builder();
}
Expand All @@ -924,6 +978,8 @@ public static class Builder {

private Annotations annotations;

private List<Icon> icons;

private Map<String, Object> meta;

public Builder uriTemplate(String uri) {
Expand Down Expand Up @@ -956,6 +1012,11 @@ public Builder annotations(Annotations annotations) {
return this;
}

public Builder icons(List<Icon> icons) {
this.icons = icons;
return this;
}

public Builder meta(Map<String, Object> meta) {
this.meta = meta;
return this;
Expand All @@ -965,7 +1026,7 @@ public ResourceTemplate build() {
Assert.hasText(uriTemplate, "uri must not be empty");
Assert.hasText(name, "name must not be empty");

return new ResourceTemplate(uriTemplate, name, title, description, mimeType, annotations, meta);
return new ResourceTemplate(uriTemplate, name, title, description, mimeType, annotations, icons, meta);
}

}
Expand Down Expand Up @@ -1169,14 +1230,20 @@ public record Prompt( // @formatter:off
@JsonProperty("title") String title,
@JsonProperty("description") String description,
@JsonProperty("arguments") List<PromptArgument> arguments,
@JsonProperty("icons") List<Icon> icons,
@JsonProperty("_meta") Map<String, Object> meta) implements Identifier { // @formatter:on

public Prompt(String name, String description, List<PromptArgument> arguments) {
this(name, null, description, arguments != null ? arguments : new ArrayList<>());
this(name, null, description, arguments != null ? arguments : new ArrayList<>(), null, null);
}

public Prompt(String name, String title, String description, List<PromptArgument> arguments) {
this(name, title, description, arguments != null ? arguments : new ArrayList<>(), null);
this(name, title, description, arguments != null ? arguments : new ArrayList<>(), null, null);
}

public Prompt(String name, String title, String description, List<PromptArgument> arguments,
Map<String, Object> meta) {
this(name, title, description, arguments != null ? arguments : new ArrayList<>(), null, meta);
}
}

Expand Down Expand Up @@ -1366,6 +1433,7 @@ public record Tool( // @formatter:off
@JsonProperty("inputSchema") JsonSchema inputSchema,
@JsonProperty("outputSchema") Map<String, Object> outputSchema,
@JsonProperty("annotations") ToolAnnotations annotations,
@JsonProperty("icons") List<Icon> icons,
@JsonProperty("_meta") Map<String, Object> meta) { // @formatter:on

public static Builder builder() {
Expand All @@ -1386,6 +1454,8 @@ public static class Builder {

private ToolAnnotations annotations;

private List<Icon> icons;

private Map<String, Object> meta;

public Builder name(String name) {
Expand Down Expand Up @@ -1428,14 +1498,19 @@ public Builder annotations(ToolAnnotations annotations) {
return this;
}

public Builder icons(List<Icon> icons) {
this.icons = icons;
return this;
}

public Builder meta(Map<String, Object> meta) {
this.meta = meta;
return this;
}

public Tool build() {
Assert.hasText(name, "name must not be empty");
return new Tool(name, title, description, inputSchema, outputSchema, annotations, meta);
return new Tool(name, title, description, inputSchema, outputSchema, annotations, icons, meta);
}

}
Expand Down
Loading