AI seeded comments from robch and then edited by stephentoub (#238)
* AI generated `///` comment updates * Fix compilation issues * Fix incorrect XML comment structure * Update all Client comments * Update all Configuration comments * Update all Messages comments * Update all Transport comments * Update all Types comments * Update all Server comments * Undo some commenting --------- Co-authored-by: Stephen Toub <stoub@microsoft.com>
This commit is contained in:
Rob Chambers
GitHub
parent
07300389ee
commit
77871c5aac
1 changed files with 4017 additions and 1066 deletions
|
|
@ -1,4 +1,4 @@
|
|||
using Microsoft.Extensions.DependencyInjection.Extensions;
|
||||
using Microsoft.Extensions.DependencyInjection.Extensions;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
using ModelContextProtocol.Hosting;
|
||||
|
|
@ -24,6 +24,7 @@ public static partial class McpServerBuilderExtensions
|
|||
/// <summary>Adds <see cref="McpServerTool"/> instances to the service collection backing <paramref name="builder"/>.</summary>
|
||||
/// <typeparam name="TToolType">The tool type.</typeparam>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// This method discovers all instance and static methods (public and non-public) on the specified <typeparamref name="TToolType"/>
|
||||
|
|
@ -54,6 +55,7 @@ public static partial class McpServerBuilderExtensions
|
|||
/// <summary>Adds <see cref="McpServerTool"/> instances to the service collection backing <paramref name="builder"/>.</summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="toolTypes">Types with marked methods to add as tools to the server.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="toolTypes"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
|
|
@ -90,8 +92,29 @@ public static partial class McpServerBuilderExtensions
|
|||
/// Adds types marked with the <see cref="McpServerToolTypeAttribute"/> attribute from the given assembly as tools to the server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="toolAssembly">The assembly to load the types from. Null to get the current assembly</param>
|
||||
/// <param name="toolAssembly">The assembly to load the types from. If <see langword="null"/>, the calling assembly will be used.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// This method scans the specified assembly (or the calling assembly if none is provided) for classes
|
||||
/// marked with the <see cref="McpServerToolTypeAttribute"/>. It then discovers all methods within those
|
||||
/// classes that are marked with the <see cref="McpServerToolAttribute"/> and registers them as <see cref="McpServerTool"/>s
|
||||
/// in the <paramref name="builder"/>'s <see cref="IServiceCollection"/>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The method automatically handles both static and instance methods. For instance methods, a new instance
|
||||
/// of the containing class will be constructed for each invocation of the tool.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Tools registered through this method can be discovered by clients using the <c>list_tools</c> request
|
||||
/// and invoked using the <c>call_tool</c> request.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Note that this method performs reflection at runtime and may not work in Native AOT scenarios. For
|
||||
/// Native AOT compatibility, consider using the generic <see cref="WithTools{TToolType}"/> method instead.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
[RequiresUnreferencedCode(WithToolsRequiresUnreferencedCodeMessage)]
|
||||
public static IMcpServerBuilder WithToolsFromAssembly(this IMcpServerBuilder builder, Assembly? toolAssembly = null)
|
||||
{
|
||||
|
|
@ -114,6 +137,7 @@ public static partial class McpServerBuilderExtensions
|
|||
/// <summary>Adds <see cref="McpServerPrompt"/> instances to the service collection backing <paramref name="builder"/>.</summary>
|
||||
/// <typeparam name="TPromptType">The prompt type.</typeparam>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// This method discovers all instance and static methods (public and non-public) on the specified <typeparamref name="TPromptType"/>
|
||||
|
|
@ -144,6 +168,7 @@ public static partial class McpServerBuilderExtensions
|
|||
/// <summary>Adds <see cref="McpServerPrompt"/> instances to the service collection backing <paramref name="builder"/>.</summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="promptTypes">Types with marked methods to add as prompts to the server.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="promptTypes"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
|
|
@ -180,8 +205,29 @@ public static partial class McpServerBuilderExtensions
|
|||
/// Adds types marked with the <see cref="McpServerPromptTypeAttribute"/> attribute from the given assembly as prompts to the server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="promptAssembly">The assembly to load the types from. Null to get the current assembly</param>
|
||||
/// <param name="promptAssembly">The assembly to load the types from. If <see langword="null"/>, the calling assembly will be used.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// This method scans the specified assembly (or the calling assembly if none is provided) for classes
|
||||
/// marked with the <see cref="McpServerPromptTypeAttribute"/>. It then discovers all methods within those
|
||||
/// classes that are marked with the <see cref="McpServerPromptAttribute"/> and registers them as <see cref="McpServerPrompt"/>s
|
||||
/// in the <paramref name="builder"/>'s <see cref="IServiceCollection"/>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The method automatically handles both static and instance methods. For instance methods, a new instance
|
||||
/// of the containing class will be constructed for each invocation of the prompt.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Prompts registered through this method can be discovered by clients using the <c>list_prompts</c> request
|
||||
/// and invoked using the <c>call_prompt</c> request.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Note that this method performs reflection at runtime and may not work in Native AOT scenarios. For
|
||||
/// Native AOT compatibility, consider using the generic <see cref="WithPrompts{TPromptType}"/> method instead.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
[RequiresUnreferencedCode(WithPromptsRequiresUnreferencedCodeMessage)]
|
||||
public static IMcpServerBuilder WithPromptsFromAssembly(this IMcpServerBuilder builder, Assembly? promptAssembly = null)
|
||||
{
|
||||
|
|
@ -198,10 +244,26 @@ public static partial class McpServerBuilderExtensions
|
|||
|
||||
#region Handlers
|
||||
/// <summary>
|
||||
/// Sets the handler for list resource templates requests.
|
||||
/// Configures a handler for listing resource templates available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes resource template list requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// This handler is responsible for providing clients with information about available resource templates
|
||||
/// that can be used to construct resource URIs.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Resource templates describe the structure of resource URIs that the server can handle. They include
|
||||
/// URI templates (according to RFC 6570) that clients can use to construct valid resource URIs.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This handler is typically paired with <see cref="WithReadResourceHandler"/> to provide a complete
|
||||
/// resource system where templates define the URI patterns and the read handler provides the actual content.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithListResourceTemplatesHandler(this IMcpServerBuilder builder, Func<RequestContext<ListResourceTemplatesRequestParams>, CancellationToken, Task<ListResourceTemplatesResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -211,10 +273,30 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for list tools requests.
|
||||
/// Configures a handler for listing tools available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler that processes list tools requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// This handler is called when a client requests a list of available tools. It should return all tools
|
||||
/// that can be invoked through the server, including their names, descriptions, and parameter specifications.
|
||||
/// The handler can optionally support pagination via the cursor mechanism for large or dynamically-generated
|
||||
/// tool collections.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// When tools are also defined using <see cref="McpServerTool"/> collection, both sets of tools
|
||||
/// will be combined in the response to clients. This allows for a mix of programmatically defined
|
||||
/// tools and dynamically generated tools.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This method is typically paired with <see cref="WithCallToolHandler"/> to provide a complete tools implementation,
|
||||
/// where <see cref="WithListToolsHandler"/> advertises available tools and <see cref="WithCallToolHandler"/>
|
||||
/// executes them when invoked by clients.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithListToolsHandler(this IMcpServerBuilder builder, Func<RequestContext<ListToolsRequestParams>, CancellationToken, Task<ListToolsResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -224,10 +306,17 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for call tool requests.
|
||||
/// Configures a handler for calling tools available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes tool calls.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// The call tool handler is responsible for executing custom tools and returning their results to clients.
|
||||
/// This method is typically paired with <see cref="WithListToolsHandler"/> to provide a complete tools implementation,
|
||||
/// where <see cref="WithListToolsHandler"/> advertises available tools and this handler executes them.
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithCallToolHandler(this IMcpServerBuilder builder, Func<RequestContext<CallToolRequestParams>, CancellationToken, Task<CallToolResponse>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -237,10 +326,30 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for list prompts requests.
|
||||
/// Configures a handler for listing prompts available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler that processes list prompts requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// This handler is called when a client requests a list of available prompts. It should return all prompts
|
||||
/// that can be invoked through the server, including their names, descriptions, and parameter specifications.
|
||||
/// The handler can optionally support pagination via the cursor mechanism for large or dynamically-generated
|
||||
/// prompt collections.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// When prompts are also defined using <see cref="McpServerPrompt"/> collection, both sets of prompts
|
||||
/// will be combined in the response to clients. This allows for a mix of programmatically defined
|
||||
/// prompts and dynamically generated prompts.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This method is typically paired with <see cref="WithGetPromptHandler"/> to provide a complete prompts implementation,
|
||||
/// where <see cref="WithListPromptsHandler"/> advertises available prompts and <see cref="WithGetPromptHandler"/>
|
||||
/// produces them when invoked by clients.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithListPromptsHandler(this IMcpServerBuilder builder, Func<RequestContext<ListPromptsRequestParams>, CancellationToken, Task<ListPromptsResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -250,10 +359,12 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for get prompt requests.
|
||||
/// Configures a handler for getting a prompt available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes prompt requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
public static IMcpServerBuilder WithGetPromptHandler(this IMcpServerBuilder builder, Func<RequestContext<GetPromptRequestParams>, CancellationToken, Task<GetPromptResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -263,10 +374,18 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for list resources requests.
|
||||
/// Configures a handler for listing resources available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes resource list requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// This handler is typically paired with <see cref="WithReadResourceHandler"/> to provide a complete resources implementation,
|
||||
/// where this handler advertises available resources and the read handler provides their content when requested.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithListResourcesHandler(this IMcpServerBuilder builder, Func<RequestContext<ListResourcesRequestParams>, CancellationToken, Task<ListResourcesResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -276,10 +395,16 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for read resources requests.
|
||||
/// Configures a handler for reading a resource available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes resource read requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// This handler is typically paired with <see cref="WithListResourcesHandler"/> to provide a complete resources implementation,
|
||||
/// where the list handler advertises available resources and the read handler provides their content when requested.
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithReadResourceHandler(this IMcpServerBuilder builder, Func<RequestContext<ReadResourceRequestParams>, CancellationToken, Task<ReadResourceResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -289,10 +414,16 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for completion complete requests.
|
||||
/// Configures a handler for auto-completion suggestions for prompt arguments or resource references available from the Model Context Protocol server.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes completion requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// The completion handler is invoked when clients request suggestions for argument values.
|
||||
/// This enables auto-complete functionality for both prompt arguments and resource references.
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithCompleteHandler(this IMcpServerBuilder builder, Func<RequestContext<CompleteRequestParams>, CancellationToken, Task<CompleteResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -302,10 +433,27 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for subscribe to resources messages.
|
||||
/// Configures a handler for resource subscription requests.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes resource subscription requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The subscribe handler is responsible for registering client interest in specific resources. When a resource
|
||||
/// changes, the server can notify all subscribed clients about the change.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This handler is typically paired with <see cref="WithUnsubscribeFromResourcesHandler"/> to provide a complete
|
||||
/// subscription management system. Resource subscriptions allow clients to maintain up-to-date information without
|
||||
/// needing to poll resources constantly.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// After registering a subscription, it's the server's responsibility to track which client is subscribed to which
|
||||
/// resources and to send appropriate notifications through the connection when resources change.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithSubscribeToResourcesHandler(this IMcpServerBuilder builder, Func<RequestContext<SubscribeRequestParams>, CancellationToken, Task<EmptyResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -315,10 +463,27 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for subscribe to resources messages.
|
||||
/// Configures a handler for resource unsubscription requests.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="handler">The handler function that processes resource unsubscription requests.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The unsubscribe handler is responsible for removing client interest in specific resources. When a client
|
||||
/// no longer needs to receive notifications about resource changes, it can send an unsubscribe request.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This handler is typically paired with <see cref="WithSubscribeToResourcesHandler"/> to provide a complete
|
||||
/// subscription management system. The unsubscribe operation is idempotent, meaning it can be called multiple
|
||||
/// times for the same resource without causing errors, even if there is no active subscription.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// After removing a subscription, the server should stop sending notifications to the client about changes
|
||||
/// to the specified resource.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithUnsubscribeFromResourcesHandler(this IMcpServerBuilder builder, Func<RequestContext<UnsubscribeRequestParams>, CancellationToken, Task<EmptyResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -328,13 +493,28 @@ public static partial class McpServerBuilderExtensions
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the handler for setting the logging level.
|
||||
/// Configures a handler for processing logging level change requests from clients.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="handler">The handler.</param>
|
||||
/// <param name="builder">The server builder instance.</param>
|
||||
/// <param name="handler">The handler that processes requests to change the logging level.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// When a client sends a <c>logging/setLevel</c> request, this handler will be invoked to process
|
||||
/// the requested level change. The server typically adjusts its internal logging level threshold
|
||||
/// and may begin sending log messages at or above the specified level to the client.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Regardless of whether a handler is provided, an <see cref="IMcpServer"/> should itself handle
|
||||
/// such notifications by updating its <see cref="IMcpServer.LoggingLevel"/> property to return the
|
||||
/// most recently set level.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static IMcpServerBuilder WithSetLoggingLevelHandler(this IMcpServerBuilder builder, Func<RequestContext<SetLevelRequestParams>, CancellationToken, Task<EmptyResult>> handler)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
||||
builder.Services.Configure<McpServerHandlers>(s => s.SetLoggingLevelHandler = handler);
|
||||
return builder;
|
||||
}
|
||||
|
|
@ -342,9 +522,23 @@ public static partial class McpServerBuilderExtensions
|
|||
|
||||
#region Transports
|
||||
/// <summary>
|
||||
/// Adds a server transport that uses stdin/stdout for communication.
|
||||
/// Adds a server transport that uses standard input (stdin) and standard output (stdout) for communication.
|
||||
/// </summary>
|
||||
/// <param name="builder">The builder instance.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// This method configures the server to communicate using the standard input and output streams,
|
||||
/// which is commonly used when the Model Context Protocol server is launched locally by a client process.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// When using this transport, the server runs as a single-session service that exits when the
|
||||
/// stdin stream is closed. This makes it suitable for scenarios where the server should terminate
|
||||
/// when the parent process disconnects.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
public static IMcpServerBuilder WithStdioServerTransport(this IMcpServerBuilder builder)
|
||||
{
|
||||
Throw.IfNull(builder);
|
||||
|
|
@ -361,6 +555,10 @@ public static partial class McpServerBuilderExtensions
|
|||
/// <param name="builder">The builder instance.</param>
|
||||
/// <param name="inputStream">The input <see cref="Stream"/> to use as standard input.</param>
|
||||
/// <param name="outputStream">The output <see cref="Stream"/> to use as standard output.</param>
|
||||
/// <returns>The builder provided in <paramref name="builder"/>.</returns>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="inputStream"/> is <see langword="null"/>.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="outputStream"/> is <see langword="null"/>.</exception>
|
||||
public static IMcpServerBuilder WithStreamServerTransport(
|
||||
this IMcpServerBuilder builder,
|
||||
Stream inputStream,
|
||||
|
|
|
|||
Loading…
Reference in a new issue