From 6fa1443a6cb0bca5ec074b13150fc46caf6ec07e Mon Sep 17 00:00:00 2001 From: Aaron Powell Date: Wed, 26 Mar 2025 14:40:48 +1100 Subject: [PATCH] Adding a base class for request params that exposes the progressToken (#99) * Adding a base class for request params that exposes the progressToken This aligns more with the type structure see in the other SDK's (eg: https://github.com/modelcontextprotocol/python-sdk/blob/main/src/mcp/types.py#L41) while also ensuring they are exposing the JSONRPCRequest (https://github.com/modelcontextprotocol/specification/blob/main/schema/2024-11-05/schema.json#L771-L806) data. Storing progressToken as an object as it could be an int or string (per https://github.com/modelcontextprotocol/specification/blob/main/schema/2024-11-05/schema.json#L1268-L1274). Fixes #67 * Using usings * Apply suggestions from code review --------- Co-authored-by: Stephen Toub --- .../Protocol/Types/CallToolRequestParams.cs | 2 +- .../Protocol/Types/CompleteRequestParams.cs | 2 +- .../Protocol/Types/CreateMessageRequestParams.cs | 2 +- .../Protocol/Types/GetPromptRequestParams.cs | 2 +- .../Protocol/Types/InitializeRequestParams.cs | 2 +- .../Protocol/Types/ReadResourceRequestParams.cs | 2 +- .../Protocol/Types/RequestParams.cs | 16 ++++++++++++++++ .../Protocol/Types/RequestParamsMetadata.cs | 15 +++++++++++++++ .../Protocol/Types/SetLevelRequestParams.cs | 2 +- .../Protocol/Types/SubscribeRequestParams.cs | 2 +- .../Protocol/Types/UnsubscribeRequestParams.cs | 2 +- 11 files changed, 40 insertions(+), 9 deletions(-) create mode 100644 src/ModelContextProtocol/Protocol/Types/RequestParams.cs create mode 100644 src/ModelContextProtocol/Protocol/Types/RequestParamsMetadata.cs diff --git a/src/ModelContextProtocol/Protocol/Types/CallToolRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/CallToolRequestParams.cs index a33d3aa..3a9b6bd 100644 --- a/src/ModelContextProtocol/Protocol/Types/CallToolRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/CallToolRequestParams.cs @@ -4,7 +4,7 @@ /// Used by the client to invoke a tool provided by the server. /// See the schema for details /// -public class CallToolRequestParams +public class CallToolRequestParams : RequestParams { /// /// Tool name. diff --git a/src/ModelContextProtocol/Protocol/Types/CompleteRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/CompleteRequestParams.cs index cb38991..eea139d 100644 --- a/src/ModelContextProtocol/Protocol/Types/CompleteRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/CompleteRequestParams.cs @@ -4,7 +4,7 @@ /// A request from the client to the server, to ask for completion options. /// See the schema for details /// -public class CompleteRequestParams +public class CompleteRequestParams : RequestParams { /// /// The reference's information diff --git a/src/ModelContextProtocol/Protocol/Types/CreateMessageRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/CreateMessageRequestParams.cs index 02be336..329e33d 100644 --- a/src/ModelContextProtocol/Protocol/Types/CreateMessageRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/CreateMessageRequestParams.cs @@ -9,7 +9,7 @@ /// clients have full discretion over model selection and should inform users before sampling. /// See the schema for details /// -public class CreateMessageRequestParams +public class CreateMessageRequestParams : RequestParams { /// /// A request to include context from one or more MCP servers (including the caller), to be attached to the prompt. The client MAY ignore this request. diff --git a/src/ModelContextProtocol/Protocol/Types/GetPromptRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/GetPromptRequestParams.cs index 5c4ce41..6b05930 100644 --- a/src/ModelContextProtocol/Protocol/Types/GetPromptRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/GetPromptRequestParams.cs @@ -4,7 +4,7 @@ /// Used by the client to get a prompt provided by the server. /// See the schema for details /// -public class GetPromptRequestParams +public class GetPromptRequestParams : RequestParams { /// /// he name of the prompt or prompt template. diff --git a/src/ModelContextProtocol/Protocol/Types/InitializeRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/InitializeRequestParams.cs index 179371a..5790c4f 100644 --- a/src/ModelContextProtocol/Protocol/Types/InitializeRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/InitializeRequestParams.cs @@ -6,7 +6,7 @@ namespace ModelContextProtocol.Protocol.Types; /// Parameters for an initialization request sent to the server. /// See the schema for details /// -public record InitializeRequestParams +public class InitializeRequestParams : RequestParams { /// /// The version of the Model Context Protocol that the client wants to use. diff --git a/src/ModelContextProtocol/Protocol/Types/ReadResourceRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/ReadResourceRequestParams.cs index fc1c563..bf345d7 100644 --- a/src/ModelContextProtocol/Protocol/Types/ReadResourceRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/ReadResourceRequestParams.cs @@ -4,7 +4,7 @@ /// Sent from the client to the server, to read a specific resource URI. /// See the schema for details /// -public class ReadResourceRequestParams +public class ReadResourceRequestParams : RequestParams { /// /// The URI of the resource to read. The URI can use any protocol; it is up to the server how to interpret it. diff --git a/src/ModelContextProtocol/Protocol/Types/RequestParams.cs b/src/ModelContextProtocol/Protocol/Types/RequestParams.cs new file mode 100644 index 0000000..73dbc2a --- /dev/null +++ b/src/ModelContextProtocol/Protocol/Types/RequestParams.cs @@ -0,0 +1,16 @@ +using System.Text.Json.Serialization; + +namespace ModelContextProtocol.Protocol.Types; + +/// +/// Base class for all request parameters. +/// See the schema for details +/// +public abstract class RequestParams +{ + /// + /// Metadata related to the tool invocation. + /// + [JsonPropertyName("_meta")] + public RequestParamsMetadata? Meta { get; init; } +} diff --git a/src/ModelContextProtocol/Protocol/Types/RequestParamsMetadata.cs b/src/ModelContextProtocol/Protocol/Types/RequestParamsMetadata.cs new file mode 100644 index 0000000..919fb8f --- /dev/null +++ b/src/ModelContextProtocol/Protocol/Types/RequestParamsMetadata.cs @@ -0,0 +1,15 @@ +using System.Text.Json.Serialization; + +namespace ModelContextProtocol.Protocol.Types; + +/// +/// Metadata related to the request. +/// +public class RequestParamsMetadata +{ + /// + /// If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications. + /// + [JsonPropertyName("progressToken")] + public object ProgressToken { get; set; } = default!; +} diff --git a/src/ModelContextProtocol/Protocol/Types/SetLevelRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/SetLevelRequestParams.cs index 9491cd7..bdc987a 100644 --- a/src/ModelContextProtocol/Protocol/Types/SetLevelRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/SetLevelRequestParams.cs @@ -6,7 +6,7 @@ namespace ModelContextProtocol.Protocol.Types; /// A request from the client to the server, to enable or adjust logging. /// See the schema for details /// -public class SetLevelRequestParams +public class SetLevelRequestParams : RequestParams { /// /// The level of logging that the client wants to receive from the server. diff --git a/src/ModelContextProtocol/Protocol/Types/SubscribeRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/SubscribeRequestParams.cs index a257154..e096367 100644 --- a/src/ModelContextProtocol/Protocol/Types/SubscribeRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/SubscribeRequestParams.cs @@ -4,7 +4,7 @@ /// Sent from the client to request updated notifications from the server whenever a particular primitive changes. /// See the schema for details /// -public class SubscribeRequestParams +public class SubscribeRequestParams : RequestParams { /// /// The URI of the resource to subscribe to. The URI can use any protocol; it is up to the server how to interpret it. diff --git a/src/ModelContextProtocol/Protocol/Types/UnsubscribeRequestParams.cs b/src/ModelContextProtocol/Protocol/Types/UnsubscribeRequestParams.cs index 13c4efd..b138c5b 100644 --- a/src/ModelContextProtocol/Protocol/Types/UnsubscribeRequestParams.cs +++ b/src/ModelContextProtocol/Protocol/Types/UnsubscribeRequestParams.cs @@ -4,7 +4,7 @@ /// Sent from the client to request not receiving updated notifications from the server whenever a primitive resource changes. /// See the schema for details /// -public class UnsubscribeRequestParams +public class UnsubscribeRequestParams : RequestParams { /// /// The URI of the resource to unsubscribe fro. The URI can use any protocol; it is up to the server how to interpret it.