d86b3277d4* Add McpServer/ClientResource{Template} and friends
This PR copies the same design used by tools and prompts to add McpServerResource, McpServerResourceAttribute, McpServerResourceTypeAttribute, McpClientResource, and then all of those for ResourceTemplate as well.
Unlike the others, [McpServerResource] is permitted not only on methods but also on properties. This convenience is afforded because such resources aren't parameterized, and thus can be easily modeled as properties, likely auto-props, e.g.
```C#
[McpServerResource]
public static BlobResourceContents MyAmazingData { get; } = Create();
```
Details about resources can be encoded into the attributes or provided via McpServerResource{Template}.Create methods. If not URI is explicitly defined, one is derived from the member name and arguments. For templates, this means manufacturing a URI template that includes variables for all non-DI parameters.
This also fixes a few issues discovered along the way:
- McpClientExtensions are updated to use `ValueTask<T>` instead of `Task<T>` where relevant.
- McpServerPrompt was missing handling for progress notifications; that's been rectified. It was also missing configuring the description on the ProtocolPrompt.
- Renamed IMcpServerPrimitive.Name to Id. For resources, names aren't unique.
- After going back and forth, updated McpServer to not fail for missing handlers and to instead register default handlers. It simplifies the implementation and makes it more consistent.
- Added a bunch of primitive types into the McpJsonUtilities JSON source generator context so that such primitives are usable with tools/prompts/resources without folks being required to add them into their own context for Native AOT. I think we should consider pushing this down to AIJsonUtilities, instead, and that will then flow up to McpJsonUtilities automatically.
* Address feedback
189 lines
7.7 KiB
C#
189 lines
7.7 KiB
C#
using Microsoft.Extensions.AI;
|
|
using ModelContextProtocol.Protocol.Messages;
|
|
using ModelContextProtocol.Protocol.Types;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Text.Json;
|
|
using System.Text.Json.Serialization;
|
|
using System.Text.Json.Serialization.Metadata;
|
|
|
|
namespace ModelContextProtocol.Utils.Json;
|
|
|
|
/// <summary>Provides a collection of utility methods for working with JSON data in the context of MCP.</summary>
|
|
public static partial class McpJsonUtilities
|
|
{
|
|
/// <summary>
|
|
/// Gets the <see cref="JsonSerializerOptions"/> singleton used as the default in JSON serialization operations.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// For Native AOT or applications disabling <see cref="JsonSerializer.IsReflectionEnabledByDefault"/>, this instance
|
|
/// includes source generated contracts for all common exchange types contained in the ModelContextProtocol library.
|
|
/// </para>
|
|
/// <para>
|
|
/// It additionally turns on the following settings:
|
|
/// <list type="number">
|
|
/// <item>Enables string-based enum serialization as implemented by <see cref="JsonStringEnumConverter"/>.</item>
|
|
/// <item>Enables <see cref="JsonIgnoreCondition.WhenWritingNull"/> as the default ignore condition for properties.</item>
|
|
/// <item>Enables <see cref="JsonNumberHandling.AllowReadingFromString"/> as the default number handling for number types.</item>
|
|
/// </list>
|
|
/// </para>
|
|
/// </remarks>
|
|
public static JsonSerializerOptions DefaultOptions { get; } = CreateDefaultOptions();
|
|
|
|
/// <summary>
|
|
/// Creates default options to use for MCP-related serialization.
|
|
/// </summary>
|
|
/// <returns>The configured options.</returns>
|
|
private static JsonSerializerOptions CreateDefaultOptions()
|
|
{
|
|
// Copy the configuration from the source generated context.
|
|
JsonSerializerOptions options = new(JsonContext.Default.Options);
|
|
|
|
// Chain with all supported types from MEAI
|
|
options.TypeInfoResolverChain.Add(AIJsonUtilities.DefaultOptions.TypeInfoResolver!);
|
|
|
|
options.MakeReadOnly();
|
|
return options;
|
|
}
|
|
|
|
internal static JsonTypeInfo<T> GetTypeInfo<T>(this JsonSerializerOptions options) =>
|
|
(JsonTypeInfo<T>)options.GetTypeInfo(typeof(T));
|
|
|
|
internal static JsonElement DefaultMcpToolSchema { get; } = ParseJsonElement("""{"type":"object"}"""u8);
|
|
internal static object? AsObject(this JsonElement element) => element.ValueKind is JsonValueKind.Null ? null : element;
|
|
|
|
internal static bool IsValidMcpToolSchema(JsonElement element)
|
|
{
|
|
if (element.ValueKind is not JsonValueKind.Object)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
foreach (JsonProperty property in element.EnumerateObject())
|
|
{
|
|
if (property.NameEquals("type"))
|
|
{
|
|
if (property.Value.ValueKind is not JsonValueKind.String ||
|
|
!property.Value.ValueEquals("object"))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
return true; // No need to check other properties
|
|
}
|
|
}
|
|
|
|
return false; // No type keyword found.
|
|
}
|
|
|
|
// Keep in sync with CreateDefaultOptions above.
|
|
[JsonSourceGenerationOptions(JsonSerializerDefaults.Web,
|
|
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
|
|
NumberHandling = JsonNumberHandling.AllowReadingFromString)]
|
|
|
|
// JSON-RPC
|
|
[JsonSerializable(typeof(JsonRpcMessage))]
|
|
[JsonSerializable(typeof(JsonRpcMessage[]))]
|
|
[JsonSerializable(typeof(JsonRpcRequest))]
|
|
[JsonSerializable(typeof(JsonRpcNotification))]
|
|
[JsonSerializable(typeof(JsonRpcResponse))]
|
|
[JsonSerializable(typeof(JsonRpcError))]
|
|
|
|
// MCP Request Params / Results
|
|
[JsonSerializable(typeof(CallToolRequestParams))]
|
|
[JsonSerializable(typeof(CallToolResponse))]
|
|
[JsonSerializable(typeof(CancelledNotification))]
|
|
[JsonSerializable(typeof(CompleteRequestParams))]
|
|
[JsonSerializable(typeof(CompleteResult))]
|
|
[JsonSerializable(typeof(CreateMessageRequestParams))]
|
|
[JsonSerializable(typeof(CreateMessageResult))]
|
|
[JsonSerializable(typeof(EmptyResult))]
|
|
[JsonSerializable(typeof(GetPromptRequestParams))]
|
|
[JsonSerializable(typeof(GetPromptResult))]
|
|
[JsonSerializable(typeof(InitializeRequestParams))]
|
|
[JsonSerializable(typeof(InitializeResult))]
|
|
[JsonSerializable(typeof(ListPromptsRequestParams))]
|
|
[JsonSerializable(typeof(ListPromptsResult))]
|
|
[JsonSerializable(typeof(ListResourcesRequestParams))]
|
|
[JsonSerializable(typeof(ListResourcesResult))]
|
|
[JsonSerializable(typeof(ListResourceTemplatesRequestParams))]
|
|
[JsonSerializable(typeof(ListResourceTemplatesResult))]
|
|
[JsonSerializable(typeof(ListRootsRequestParams))]
|
|
[JsonSerializable(typeof(ListRootsResult))]
|
|
[JsonSerializable(typeof(ListToolsRequestParams))]
|
|
[JsonSerializable(typeof(ListToolsResult))]
|
|
[JsonSerializable(typeof(LoggingMessageNotificationParams))]
|
|
[JsonSerializable(typeof(PingResult))]
|
|
[JsonSerializable(typeof(ProgressNotification))]
|
|
[JsonSerializable(typeof(ReadResourceRequestParams))]
|
|
[JsonSerializable(typeof(ReadResourceResult))]
|
|
[JsonSerializable(typeof(ResourceUpdatedNotificationParams))]
|
|
[JsonSerializable(typeof(SetLevelRequestParams))]
|
|
[JsonSerializable(typeof(SubscribeRequestParams))]
|
|
[JsonSerializable(typeof(UnsubscribeRequestParams))]
|
|
[JsonSerializable(typeof(IReadOnlyDictionary<string, object>))]
|
|
|
|
// Primitive types for use in consuming AIFunctions
|
|
[JsonSerializable(typeof(string))]
|
|
[JsonSerializable(typeof(byte))]
|
|
[JsonSerializable(typeof(byte?))]
|
|
[JsonSerializable(typeof(sbyte))]
|
|
[JsonSerializable(typeof(sbyte?))]
|
|
[JsonSerializable(typeof(ushort))]
|
|
[JsonSerializable(typeof(ushort?))]
|
|
[JsonSerializable(typeof(short))]
|
|
[JsonSerializable(typeof(short?))]
|
|
[JsonSerializable(typeof(uint))]
|
|
[JsonSerializable(typeof(uint?))]
|
|
[JsonSerializable(typeof(int))]
|
|
[JsonSerializable(typeof(int?))]
|
|
[JsonSerializable(typeof(ulong))]
|
|
[JsonSerializable(typeof(ulong?))]
|
|
[JsonSerializable(typeof(long))]
|
|
[JsonSerializable(typeof(long?))]
|
|
[JsonSerializable(typeof(nuint))]
|
|
[JsonSerializable(typeof(nuint?))]
|
|
[JsonSerializable(typeof(nint))]
|
|
[JsonSerializable(typeof(nint?))]
|
|
[JsonSerializable(typeof(bool))]
|
|
[JsonSerializable(typeof(bool?))]
|
|
[JsonSerializable(typeof(char))]
|
|
[JsonSerializable(typeof(char?))]
|
|
[JsonSerializable(typeof(float))]
|
|
[JsonSerializable(typeof(float?))]
|
|
[JsonSerializable(typeof(double))]
|
|
[JsonSerializable(typeof(double?))]
|
|
[JsonSerializable(typeof(decimal))]
|
|
[JsonSerializable(typeof(decimal?))]
|
|
[JsonSerializable(typeof(Guid))]
|
|
[JsonSerializable(typeof(Guid?))]
|
|
[JsonSerializable(typeof(Uri))]
|
|
[JsonSerializable(typeof(Version))]
|
|
[JsonSerializable(typeof(TimeSpan))]
|
|
[JsonSerializable(typeof(TimeSpan?))]
|
|
[JsonSerializable(typeof(DateTime))]
|
|
[JsonSerializable(typeof(DateTime?))]
|
|
[JsonSerializable(typeof(DateTimeOffset))]
|
|
[JsonSerializable(typeof(DateTimeOffset?))]
|
|
#if NET
|
|
[JsonSerializable(typeof(DateOnly))]
|
|
[JsonSerializable(typeof(DateOnly?))]
|
|
[JsonSerializable(typeof(TimeOnly))]
|
|
[JsonSerializable(typeof(TimeOnly?))]
|
|
[JsonSerializable(typeof(Half))]
|
|
[JsonSerializable(typeof(Half?))]
|
|
[JsonSerializable(typeof(Int128))]
|
|
[JsonSerializable(typeof(Int128?))]
|
|
[JsonSerializable(typeof(UInt128))]
|
|
[JsonSerializable(typeof(UInt128?))]
|
|
#endif
|
|
|
|
[ExcludeFromCodeCoverage]
|
|
internal sealed partial class JsonContext : JsonSerializerContext;
|
|
|
|
private static JsonElement ParseJsonElement(ReadOnlySpan<byte> utf8Json)
|
|
{
|
|
Utf8JsonReader reader = new(utf8Json);
|
|
return JsonElement.ParseValue(ref reader);
|
|
}
|
|
}
|