Add Conformance tests for the server

.github/workflows/ci-build-test.yml

@@ -67,6 +67,9 @@ jobs:
     - name: 📦 Install dependencies for tests
       run: npm install @modelcontextprotocol/server-memory
 
+    - name: 📦 Install dependencies for tests
+      run: npm install @modelcontextprotocol/conformance
+
     - name: 🏗️ Build
       run: make build CONFIGURATION=${{ matrix.configuration }}
 

ModelContextProtocol.slnx

@@ -70,6 +70,8 @@
   <Folder Name="/tests/">
     <Project Path="tests/ModelContextProtocol.Analyzers.Tests/ModelContextProtocol.Analyzers.Tests.csproj" />
     <Project Path="tests/ModelContextProtocol.AspNetCore.Tests/ModelContextProtocol.AspNetCore.Tests.csproj" />
+    <Project Path="tests/ModelContextProtocol.ConformanceServer/ModelContextProtocol.ConformanceServer.csproj" />
+    <Project Path="tests/ModelContextProtocol.ConformanceTests/ModelContextProtocol.ConformanceTests.csproj" />
     <Project Path="tests/ModelContextProtocol.TestOAuthServer/ModelContextProtocol.TestOAuthServer.csproj" />
     <Project Path="tests/ModelContextProtocol.Tests/ModelContextProtocol.Tests.csproj" />
     <Project Path="tests/ModelContextProtocol.TestServer/ModelContextProtocol.TestServer.csproj" />

tests/ModelContextProtocol.ConformanceServer/ModelContextProtocol.ConformanceServer.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../../src/ModelContextProtocol.AspNetCore/ModelContextProtocol.AspNetCore.csproj" />
+  </ItemGroup>
+
+</Project>

tests/ModelContextProtocol.ConformanceServer/ModelContextProtocol.ConformanceServer.http

@@ -0,0 +1,75 @@
+@HostAddress = http://localhost:3001
+
+POST {{HostAddress}}/
+Accept: application/json, text/event-stream
+Content-Type: application/json
+
+{
+    "jsonrpc": "2.0",
+    "id": 1,
+    "method": "ping"
+}
+
+###
+
+POST {{HostAddress}}/
+Accept: application/json, text/event-stream
+Content-Type: application/json
+
+{
+    "jsonrpc": "2.0",
+    "id": 2,
+    "method": "initialize",
+    "params": {
+        "clientInfo": {
+            "name": "RestClient",
+            "version": "0.1.0"
+        },
+        "capabilities": {},
+        "protocolVersion": "2025-06-18"
+    }
+}
+
+###
+
+@SessionId = XxIXkrK210aKVnZxD8Iu_g
+
+POST {{HostAddress}}/
+Accept: application/json, text/event-stream
+Content-Type: application/json
+MCP-Protocol-Version: 2025-06-18
+Mcp-Session-Id: {{SessionId}}
+
+{
+    "jsonrpc": "2.0",
+    "id": 3,
+    "method": "tools/list"
+}
+
+###
+
+POST {{HostAddress}}/
+Accept: application/json, text/event-stream
+Content-Type: application/json
+MCP-Protocol-Version: 2025-06-18
+Mcp-Session-Id: {{SessionId}}
+
+{
+    "jsonrpc": "2.0",
+    "id": 4,
+    "method": "resources/list"
+}
+
+###
+
+POST {{HostAddress}}/
+Accept: application/json, text/event-stream
+Content-Type: application/json
+MCP-Protocol-Version: 2025-06-18
+Mcp-Session-Id: {{SessionId}}
+
+{
+    "jsonrpc": "2.0",
+    "id": 5,
+    "method": "prompts/list"
+}

tests/ModelContextProtocol.ConformanceServer/Program.cs

@@ -0,0 +1,97 @@
+using ConformanceServer.Prompts;
+using ConformanceServer.Resources;
+using ConformanceServer.Tools;
+using Microsoft.Extensions.AI;
+using ModelContextProtocol;
+using ModelContextProtocol.Protocol;
+using System.Collections.Concurrent;
+
+var builder = WebApplication.CreateBuilder(args);
+
+// Dictionary of session IDs to a set of resource URIs they are subscribed to
+// The value is a ConcurrentDictionary used as a thread-safe HashSet
+// because .NET does not have a built-in concurrent HashSet
+ConcurrentDictionary<string, ConcurrentDictionary<string, byte>> subscriptions = new();
+
+builder.Services
+    .AddMcpServer()
+    .WithHttpTransport()
+    .WithTools<ConformanceTools>()
+    .WithPrompts<ConformancePrompts>()
+    .WithResources<ConformanceResources>()
+    .WithSubscribeToResourcesHandler(async (ctx, ct) =>
+    {
+        if (ctx.Server.SessionId == null)
+        {
+            throw new McpException("Cannot add subscription for server with null SessionId");
+        }
+        if (ctx.Params?.Uri is { } uri)
+        {
+            subscriptions[ctx.Server.SessionId].TryAdd(uri, 0);
+
+            await ctx.Server.SampleAsync([
+                new ChatMessage(ChatRole.System, "You are a helpful test server"),
+                new ChatMessage(ChatRole.User, $"Resource {uri}, context: A new subscription was started"),
+            ],
+            options: new ChatOptions
+            {
+                MaxOutputTokens = 100,
+                Temperature = 0.7f,
+            },
+            cancellationToken: ct);
+        }
+
+        return new EmptyResult();
+    })
+    .WithUnsubscribeFromResourcesHandler(async (ctx, ct) =>
+    {
+        if (ctx.Server.SessionId == null)
+        {
+            throw new McpException("Cannot remove subscription for server with null SessionId");
+        }
+        if (ctx.Params?.Uri is { } uri)
+        {
+            subscriptions[ctx.Server.SessionId].TryRemove(uri, out _);
+        }
+        return new EmptyResult();
+    })
+    .WithCompleteHandler(async (ctx, ct) =>
+    {
+        // Basic completion support - returns empty array for conformance
+        // Real implementations would provide contextual suggestions
+        return new CompleteResult
+        {
+            Completion = new Completion
+            {
+                Values = [],
+                HasMore = false,
+                Total = 0
+            }
+        };
+    })
+    .WithSetLoggingLevelHandler(async (ctx, ct) =>
+    {
+        if (ctx.Params?.Level is null)
+        {
+            throw new McpProtocolException("Missing required argument 'level'", McpErrorCode.InvalidParams);
+        }
+
+        // The SDK updates the LoggingLevel field of the McpServer
+        // Send a log notification to confirm the level was set
+        await ctx.Server.SendNotificationAsync("notifications/message", new
+        {
+            Level = "info",
+            Logger = "conformance-test-server",
+            Data = $"Log level set to: {ctx.Params.Level}",
+        }, cancellationToken: ct);
+
+        return new EmptyResult();
+    });
+
+var app = builder.Build();
+
+app.MapMcp();
+
+app.MapGet("/health", () => TypedResults.Ok("Healthy"));
+
+app.Run();

tests/ModelContextProtocol.ConformanceServer/Prompts/ConformancePrompts.cs

@@ -0,0 +1,67 @@
+using ModelContextProtocol.Server;
+using ModelContextProtocol.Protocol;
+using Microsoft.Extensions.AI;
+using System.ComponentModel;
+
+namespace ConformanceServer.Prompts;
+
+public class ConformancePrompts
+{
+    // Sample base64 encoded 1x1 red PNG pixel for testing
+    private const string TestImageBase64 =
+      "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8DwHwAFBQIAX8jx0gAAAABJRU5ErkJggg==";
+
+    [McpServerPrompt(Name = "test_simple_prompt"), Description("Simple prompt without arguments")]
+    public static string SimplePrompt() => "This is a simple prompt without arguments";
+
+    [McpServerPrompt(Name = "test_prompt_with_arguments"), Description("Parameterized prompt")]
+    public static string ParameterizedPrompt(
+        [Description("First test argument")] string arg1,
+        [Description("Second test argument")] string arg2)
+    {
+        return $"Prompt with arguments: arg1={arg1}, arg2={arg2}";
+    }
+
+    [McpServerPrompt(Name = "test_prompt_with_embedded_resource"), Description("Prompt with embedded resource")]
+    public static IEnumerable<PromptMessage> PromptWithEmbeddedResource(
+        [Description("URI of the resource to embed")] string resourceUri)
+    {
+        return [
+            new PromptMessage
+            {
+                Role = Role.User,
+                Content = new EmbeddedResourceBlock
+                {
+                    Resource = new TextResourceContents
+                    {
+                        Uri = resourceUri,
+                        Text = "Embedded resource content for testing.",
+                        MimeType = "text/plain"
+                    }
+                }
+            },
+            new PromptMessage { Role = Role.User, Content = new TextContentBlock { Text = "Please process the embedded resource above." } },
+        ];
+    }
+
+    [McpServerPrompt(Name = "test_prompt_with_image"), Description("Prompt with image")]
+    public static IEnumerable<PromptMessage> PromptWithImage()
+    {
+        return [
+            new PromptMessage
+            {
+                Role = Role.User,
+                Content = new ImageContentBlock
+                {
+                    MimeType = "image/png",
+                    Data = TestImageBase64
+                }
+            },
+            new PromptMessage
+            {
+                Role = Role.User,
+                Content = new TextContentBlock { Text = "Please analyze the image above." }
+            },
+        ];
+    }
+}

tests/ModelContextProtocol.ConformanceServer/Properties/launchSettings.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "http://localhost:3001",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "https://localhost:7292;http://localhost:3001",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

tests/ModelContextProtocol.ConformanceServer/Resources/ConformanceResources.cs

@@ -0,0 +1,71 @@
+using ModelContextProtocol.Protocol;
+using ModelContextProtocol.Server;
+using System.ComponentModel;
+using System.Text.Json;
+
+namespace ConformanceServer.Resources;
+
+[McpServerResourceType]
+public class ConformanceResources
+{
+    // Sample base64 encoded 1x1 red PNG pixel for testing
+    private const string TestImageBase64 =
+        "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8DwHwAFBQIAX8jx0gAAAABJRU5ErkJggg==";
+
+    /// <summary>
+    /// Static text resource for testing
+    /// </summary>
+    [McpServerResource(UriTemplate = "test://static-text", Name = "Static Text Resource", MimeType = "text/plain")]
+    [Description("A static text resource for testing")]
+    public static string StaticText()
+    {
+        return "This is the content of the static text resource.";
+    }
+
+    /// <summary>
+    /// Static binary resource (image) for testing
+    /// </summary>
+    [McpServerResource(UriTemplate = "test://static-binary", Name = "Static Binary Resource", MimeType = "image/png")]
+    [Description("A static binary resource (image) for testing")]
+    public static BlobResourceContents StaticBinary()
+    {
+        return new BlobResourceContents
+        {
+            Uri = "test://static-binary",
+            MimeType = "image/png",
+            Blob = TestImageBase64
+        };
+    }
+
+    /// <summary>
+    /// Resource template with parameter substitution
+    /// </summary>
+    [McpServerResource(UriTemplate = "test://template/{id}/data", Name = "Resource Template", MimeType = "application/json")]
+    [Description("A resource template with parameter substitution")]
+    public static TextResourceContents TemplateResource(string id)
+    {
+        var data = new
+        {
+            id = id,
+            templateTest = true,
+            data = $"Data for ID: {id}"
+        };
+
+        return new TextResourceContents
+        {
+            Uri = $"test://template/{id}/data",
+            MimeType = "application/json",
+            Text = JsonSerializer.Serialize(data)
+        };
+    }
+
+    /// <summary>
+    /// Subscribable resource that can send updates
+    /// </summary>
+    [McpServerResource(UriTemplate = "test://watched-resource", Name = "Watched Resource", MimeType = "text/plain")]
+    [Description("A resource that auto-updates every 3 seconds")]
+    public static string WatchedResource()
+    {
+        return "Watched resource content";
+    }
+}