-
Notifications
You must be signed in to change notification settings - Fork 532
Implement SEP-973: Icons and metadata support for Implementations, Resources, Tools, and Prompts #802
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.
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
Merged
Implement SEP-973: Icons and metadata support for Implementations, Resources, Tools, and Prompts #802
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
941bc0e
Initial plan
Copilot 31ad1e4
Initial plan for SEP-973 implementation
Copilot 8b1b684
Implement SEP-973: Add Icon class and icon support to Implementation,…
Copilot 24517c2
Complete SEP-973 implementation with documentation and fix property c…
Copilot 6c42203
Address code review feedback: improve tests, remove docs, split test …
Copilot f666ff0
Fix tests to use S.T.J. source generator
MackinnonBuck 3ac0678
Styling fixes
MackinnonBuck 9e4eba3
Simplify Icons property documentation as suggested in code review
Copilot 8a6f6fd
Rename Icon.Src property to Icon.Source for more .NET-y naming
Copilot 2e077dc
Add icon support to McpServerTool infrastructure and attributes
Copilot 6de63f5
Cleanup
MackinnonBuck 4bcbe1c
Refactor icon tests to use Delegate overload instead of MethodInfo pa…
Copilot a25abde
Change Icon.Sizes property from string to IList<string> per spec update
Copilot ae081ca
Add icon support to Prompts and Resources (CreateOptions and Attributes)
Copilot f37de15
Add client-server integration tests for Icons and WebsiteUrl
Copilot 8e423fd
Fix nullability warnings
MackinnonBuck 803e326
Revert "Add client-server integration tests for Icons and WebsiteUrl"
MackinnonBuck 38b4032
More nullability fixes
MackinnonBuck 0cd7f87
Add more tests
MackinnonBuck facca54
Address code review feedback: add Theme property, fix docs, improve t…
Copilot bb762b2
Update Icon tests to exercise Theme property
Copilot 608cf0d
Add Theme property assertions to client-server integration tests
Copilot c2a3252
Fix nullability
jozkee 45dd79a
Merge branch 'main' into copilot/fix-753
jozkee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
using System.Text.Json.Serialization; | ||
|
||
namespace ModelContextProtocol.Protocol; | ||
|
||
/// <summary> | ||
/// Represents an icon that can be used to visually identify an implementation, resource, tool, or prompt. | ||
/// </summary> | ||
/// <remarks> | ||
/// <para> | ||
/// Icons enhance user interfaces by providing visual context and improving the discoverability of available functionality. | ||
/// Each icon includes a source URI pointing to the icon resource, and optional MIME type and size information. | ||
/// </para> | ||
/// <para> | ||
/// Clients that support rendering icons MUST support at least the following MIME types: | ||
/// </para> | ||
/// <list type="bullet"> | ||
/// <item><description>image/png - PNG images (safe, universal compatibility)</description></item> | ||
/// <item><description>image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)</description></item> | ||
/// </list> | ||
/// <para> | ||
/// Clients that support rendering icons SHOULD also support: | ||
/// </para> | ||
/// <list type="bullet"> | ||
/// <item><description>image/svg+xml - SVG images (scalable but requires security precautions)</description></item> | ||
/// <item><description>image/webp - WebP images (modern, efficient format)</description></item> | ||
/// </list> | ||
/// <para> | ||
/// See the <see href="https://github.com/modelcontextprotocol/specification/blob/main/schema/">schema</see> for details. | ||
/// </para> | ||
/// </remarks> | ||
public sealed class Icon | ||
{ | ||
/// <summary> | ||
/// Gets or sets the URI pointing to the icon resource. | ||
/// </summary> | ||
/// <remarks> | ||
/// <para> | ||
/// This can be an HTTP/HTTPS URL pointing to an image file or a data URI with base64-encoded image data. | ||
/// </para> | ||
/// <para> | ||
/// Consumers SHOULD take steps to ensure URLs serving icons are from the same domain as the client/server | ||
/// or a trusted domain. | ||
/// </para> | ||
/// <para> | ||
/// Consumers SHOULD take appropriate precautions when consuming SVGs as they can contain executable JavaScript. | ||
/// </para> | ||
/// </remarks> | ||
[JsonPropertyName("src")] | ||
public required string Source { get; init; } | ||
|
||
/// <summary> | ||
/// Gets or sets the optional MIME type of the icon. | ||
/// </summary> | ||
/// <remarks> | ||
/// This can be used to override the server's MIME type if it's missing or generic. | ||
/// Common values include "image/png", "image/jpeg", "image/svg+xml", and "image/webp". | ||
/// </remarks> | ||
[JsonPropertyName("mimeType")] | ||
public string? MimeType { get; init; } | ||
|
||
/// <summary> | ||
/// Gets or sets the optional size specifications for the icon. | ||
/// </summary> | ||
/// <remarks> | ||
/// <para> | ||
/// This can specify one or more sizes at which the icon file can be used. | ||
/// Examples include "48x48", "any" for scalable formats like SVG. | ||
/// </para> | ||
/// <para> | ||
/// If not provided, clients should assume that the icon can be used at any size. | ||
/// </para> | ||
/// </remarks> | ||
[JsonPropertyName("sizes")] | ||
public IList<string>? Sizes { get; init; } | ||
|
||
/// <summary> | ||
/// Gets or sets the optional theme for this icon. | ||
/// </summary> | ||
/// <remarks> | ||
/// Can be "light", "dark", or a custom theme identifier. | ||
/// Used to specify which UI theme the icon is designed for. | ||
/// </remarks> | ||
[JsonPropertyName("theme")] | ||
public string? Theme { get; init; } | ||
} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.