Merge branch 'main' into ddelimarsky/docs

Author: eiriktsarpalis

README.MD

@@ -4,7 +4,7 @@
 
 The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers.
 
-> [!NOTE]  
+> [!NOTE]
 > This repo is still in preview, breaking changes can be introduced without prior notice.
 
 ## About MCP
@@ -65,7 +65,7 @@ IList<AIFunction> tools = await client.GetAIFunctionsAsync();
 IChatClient chatClient = ...;
 var response = await chatClient.GetResponseAsync(
     "your prompt here",
-    new() 
+    new()
     {
         Tools = [.. tools],
     });
@@ -110,7 +110,7 @@ using Microsoft.Extensions.Logging.Abstractions;
 McpServerOptions options = new()
 {
     ServerInfo = new() { Name = "MyServer", Version = "1.0.0" },
-    Capabilities = new() 
+    Capabilities = new()
     {
         Tools = new()
         {
@@ -166,6 +166,10 @@ await server.StartAsync();
 await Task.Delay(Timeout.Infinite);
 ```
 
+## Acknowledgements
+
+The starting point for this library was a project called [mcpdotnet](https://github.com/PederHP/mcpdotnet), initiated by [Peder Holdgaard Pederson](https://github.com/PederHP). We are grateful for the work done by Peder and other contributors to that repository, which created a solid foundation for this library.
+
 ## License
 
 This project is licensed under the [MIT License](LICENSE).

src/ModelContextProtocol/Protocol/Transport/SseResponseStreamTransport.cs

@@ -20,7 +20,7 @@ public sealed class SseResponseStreamTransport(Stream sseResponseStream) : ITran
     private Utf8JsonWriter? _jsonWriter;
 
     /// <inheritdoc/>
-    public bool IsConnected => _sseWriteTask?.IsCompleted == false;
+    public bool IsConnected { get; private set; }
 
     /// <summary>
     /// Starts the transport and writes the JSON-RPC messages sent via <see cref="SendMessageAsync(IJsonRpcMessage, CancellationToken)"/>
@@ -41,6 +41,8 @@ void WriteJsonRpcMessageToBuffer(SseItem<IJsonRpcMessage?> item, IBufferWriter<b
             JsonSerializer.Serialize(GetUtf8JsonWriter(writer), item.Data, McpJsonUtilities.DefaultOptions.GetTypeInfo<IJsonRpcMessage?>());
         }
 
+        IsConnected = true;
+
         // The very first SSE event isn't really an IJsonRpcMessage, but there's no API to write a single item of a different type,
         // so we fib and special-case the "endpoint" event type in the formatter.
         _outgoingSseChannel.Writer.TryWrite(new SseItem<IJsonRpcMessage?>(null, "endpoint"));
@@ -55,6 +57,7 @@ void WriteJsonRpcMessageToBuffer(SseItem<IJsonRpcMessage?> item, IBufferWriter<b
     /// <inheritdoc/>
     public ValueTask DisposeAsync()
     {
+        IsConnected = false;
         _incomingChannel.Writer.TryComplete();
         _outgoingSseChannel.Writer.TryComplete();
         return new ValueTask(_sseWriteTask ?? Task.CompletedTask);
@@ -63,7 +66,7 @@ public ValueTask DisposeAsync()
     /// <inheritdoc/>
     public async Task SendMessageAsync(IJsonRpcMessage message, CancellationToken cancellationToken = default)
     {
-        if (_sseWriteTask is null)
+        if (!IsConnected)
         {
             throw new InvalidOperationException($"Transport is not connected. Make sure to call {nameof(RunAsync)} first.");
         }
@@ -80,7 +83,7 @@ public async Task SendMessageAsync(IJsonRpcMessage message, CancellationToken ca
     /// <exception cref="InvalidOperationException">Thrown when there is an attempt to process a message before calling <see cref="RunAsync(CancellationToken)"/>.</exception>
     public async Task OnMessageReceivedAsync(IJsonRpcMessage message, CancellationToken cancellationToken)
     {
-        if (_sseWriteTask is null)
+        if (!IsConnected)
         {
             throw new InvalidOperationException($"Transport is not connected. Make sure to call {nameof(RunAsync)} first.");
         }

tests/ModelContextProtocol.TestSseServer/Program.cs

@@ -10,9 +10,10 @@ namespace ModelContextProtocol.TestSseServer;
 
 public class Program
 {
-    private static ILoggerFactory CreateLoggerFactory()
+    private static ILoggerFactory CreateLoggerFactory() => LoggerFactory.Create(ConfigureSerilog);
+
+    public static void ConfigureSerilog(ILoggingBuilder loggingBuilder)
     {
-        // Use serilog
         Log.Logger = new LoggerConfiguration()
             .MinimumLevel.Verbose() // Capture all log levels
             .WriteTo.File(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "logs", "TestServer_.log"),
@@ -21,15 +22,12 @@ private static ILoggerFactory CreateLoggerFactory()
             .CreateLogger();
 
         var logsPath = Path.Combine(AppContext.BaseDirectory, "testserver.log");
-        return LoggerFactory.Create(builder =>
-        {
-            builder.AddSerilog();
-        });
+        loggingBuilder.AddSerilog();
     }
 
     public static Task Main(string[] args) => MainAsync(args);
 
-    public static async Task MainAsync(string[] args, CancellationToken cancellationToken = default)
+    public static async Task MainAsync(string[] args, ILoggerFactory? loggerFactory = null, CancellationToken cancellationToken = default)
     {
         Console.WriteLine("Starting server...");
 
@@ -385,7 +383,7 @@ static CreateMessageRequestParams CreateRequestSamplingParams(string context, st
             },
         };
 
-        using var loggerFactory = CreateLoggerFactory();
+        loggerFactory ??= CreateLoggerFactory();
         server = McpServerFactory.Create(new HttpListenerSseServerTransport("TestServer", 3001, loggerFactory), options, loggerFactory);
 
         Console.WriteLine("Server initialized.");

tests/ModelContextProtocol.Tests/ClientIntegrationTestFixture.cs

@@ -5,9 +5,10 @@
 
 namespace ModelContextProtocol.Tests;
 
-public class ClientIntegrationTestFixture : IDisposable
+public class ClientIntegrationTestFixture
 {
-    public ILoggerFactory LoggerFactory { get; }
+    private ILoggerFactory? _loggerFactory;
+
     public McpClientOptions DefaultOptions { get; }
     public McpServerConfig EverythingServerConfig { get; }
     public McpServerConfig TestServerConfig { get; }
@@ -16,10 +17,6 @@ public class ClientIntegrationTestFixture : IDisposable
 
     public ClientIntegrationTestFixture()
     {
-        LoggerFactory = Microsoft.Extensions.Logging.LoggerFactory.Create(builder =>
-            builder.AddConsole()
-            .SetMinimumLevel(LogLevel.Debug));
-
         DefaultOptions = new()
         {
             ClientInfo = new() { Name = "IntegrationTestClient", Version = "1.0.0" },
@@ -56,17 +53,16 @@ public ClientIntegrationTestFixture()
         }
     }
 
+    public void Initialize(ILoggerFactory loggerFactory)
+    {
+        _loggerFactory = loggerFactory;
+    }
+
     public Task<IMcpClient> CreateClientAsync(string clientId, McpClientOptions? clientOptions = null) =>
         McpClientFactory.CreateAsync(clientId switch
         {
             "everything" => EverythingServerConfig,
             "test_server" => TestServerConfig,
             _ => throw new ArgumentException($"Unknown client ID: {clientId}")
-        }, clientOptions ?? DefaultOptions, loggerFactory: LoggerFactory);
-
-    public void Dispose()
-    {
-        LoggerFactory?.Dispose();
-        GC.SuppressFinalize(this);
-    }
+        }, clientOptions ?? DefaultOptions, loggerFactory: _loggerFactory);
 }

tests/ModelContextProtocol.Tests/ClientIntegrationTests.cs

@@ -6,22 +6,25 @@
 using System.Text.Json;
 using ModelContextProtocol.Configuration;
 using ModelContextProtocol.Protocol.Transport;
+using ModelContextProtocol.Tests.Utils;
 using Xunit.Sdk;
 using System.Text.Encodings.Web;
 using System.Text.Json.Serialization.Metadata;
 using System.Text.Json.Serialization;
 
 namespace ModelContextProtocol.Tests;
 
-public class ClientIntegrationTests : IClassFixture<ClientIntegrationTestFixture>
+public class ClientIntegrationTests : LoggedTest, IClassFixture<ClientIntegrationTestFixture>
 {
     private static readonly string? s_openAIKey = Environment.GetEnvironmentVariable("AI:OpenAI:ApiKey")!;
 
     private readonly ClientIntegrationTestFixture _fixture;
 
-    public ClientIntegrationTests(ClientIntegrationTestFixture fixture)
+    public ClientIntegrationTests(ClientIntegrationTestFixture fixture, ITestOutputHelper testOutputHelper)
+        : base(testOutputHelper)
     {
         _fixture = fixture;
+        _fixture.Initialize(LoggerFactory);
     }
 
     public static IEnumerable<object[]> GetClients() =>
@@ -474,7 +477,7 @@ public async Task CallTool_Stdio_MemoryServer()
         await using var client = await McpClientFactory.CreateAsync(
             serverConfig, 
             clientOptions, 
-            loggerFactory: _fixture.LoggerFactory, 
+            loggerFactory: LoggerFactory, 
             cancellationToken: TestContext.Current.CancellationToken);
 
         // act

tests/ModelContextProtocol.Tests/Server/McpServerFactoryTests.cs

@@ -1,18 +1,18 @@
 using ModelContextProtocol.Protocol.Transport;
 using ModelContextProtocol.Protocol.Types;
 using ModelContextProtocol.Server;
-using Microsoft.Extensions.Logging.Abstractions;
+using ModelContextProtocol.Tests.Utils;
 using Moq;
 
 namespace ModelContextProtocol.Tests.Server;
 
-public class McpServerFactoryTests
+public class McpServerFactoryTests : LoggedTest
 {
     private readonly Mock<IServerTransport> _serverTransport;
     private readonly McpServerOptions _options;
-    private readonly IServiceProvider _serviceProvider;
 
-    public McpServerFactoryTests()
+    public McpServerFactoryTests(ITestOutputHelper testOutputHelper)
+        : base(testOutputHelper)
     {
         _serverTransport = new Mock<IServerTransport>();
         _options = new McpServerOptions
@@ -21,14 +21,13 @@ public McpServerFactoryTests()
             ProtocolVersion = "1.0",
             InitializationTimeout = TimeSpan.FromSeconds(30)
         };
-        _serviceProvider = new Mock<IServiceProvider>().Object;
     }
 
     [Fact]
     public async Task Create_Should_Initialize_With_Valid_Parameters()
     {
         // Arrange & Act
-        await using IMcpServer server = McpServerFactory.Create(_serverTransport.Object, _options, NullLoggerFactory.Instance);
+        await using IMcpServer server = McpServerFactory.Create(_serverTransport.Object, _options, LoggerFactory);
 
         // Assert
         Assert.NotNull(server);
@@ -38,13 +37,13 @@ public async Task Create_Should_Initialize_With_Valid_Parameters()
     public void Constructor_Throws_For_Null_ServerTransport()
     {
         // Arrange, Act & Assert
-        Assert.Throws<ArgumentNullException>("serverTransport", () => McpServerFactory.Create(null!, _options, NullLoggerFactory.Instance));
+        Assert.Throws<ArgumentNullException>("serverTransport", () => McpServerFactory.Create(null!, _options, LoggerFactory));
     }
 
     [Fact]
     public void Constructor_Throws_For_Null_Options()
     {
         // Arrange, Act & Assert
-        Assert.Throws<ArgumentNullException>("serverOptions", () => McpServerFactory.Create(_serverTransport.Object, null!, NullLoggerFactory.Instance));
+        Assert.Throws<ArgumentNullException>("serverOptions", () => McpServerFactory.Create(_serverTransport.Object, null!, LoggerFactory));
     }
 }