Merge branch 'modelcontextprotocol:main' into main

Author: jeffhandley

.editorconfig

@@ -4,6 +4,9 @@ root = true
 # C# files
 [*.cs]
 
+# Compiler
+dotnet_diagnostic.CS1998.severity = suggestion      # CS1998: Missing awaits
+
 # Code Analysis
 dotnet_diagnostic.CA1002.severity = none            # CA1002: Do not expose generic lists
 dotnet_diagnostic.CA1031.severity = none            # CA1031: Do not catch general exception types

Directory.Packages.props

@@ -58,6 +58,10 @@
     <PackageVersion Include="Moq" Version="4.20.72" />
     <PackageVersion Include="OpenTelemetry" Version="1.11.2" />
     <PackageVersion Include="OpenTelemetry.Exporter.InMemory" Version="1.11.2" />
+    <PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.2" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.Http " Version="1.11.0" />
+    <PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.11.2"  />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.11.1"  />
     <PackageVersion Include="Serilog.Extensions.Hosting" Version="9.0.0" />
     <PackageVersion Include="Serilog.Extensions.Logging" Version="9.0.0" />
     <PackageVersion Include="Serilog.Sinks.Console" Version="6.0.0" />

README.md

@@ -31,7 +31,7 @@ To get started writing a client, the `McpClientFactory.CreateAsync` method is us
 to a server. Once you have an `IMcpClient`, you can interact with it, such as to enumerate all available tools and invoke tools.
 
 ```csharp
-var clientTransport = new StdioClientTransport(new()
+var clientTransport = new StdioClientTransport(new StdioClientTransportOptions
 {
     Name = "Everything",
     Command = "npx",
@@ -50,7 +50,7 @@ foreach (var tool in await client.ListToolsAsync())
 var result = await client.CallToolAsync(
     "echo",
     new Dictionary<string, object?>() { ["message"] = "Hello MCP!" },
-    CancellationToken.None);
+    cancellationToken:CancellationToken.None);
 
 // echo always returns one and only one text content object
 Console.WriteLine(result.Content.First(c => c.Type == "text").Text);
@@ -60,7 +60,7 @@ You can find samples demonstrating how to use ModelContextProtocol with an LLM S
 
 Clients can connect to any MCP server, not just ones created using this library. The protocol is designed to be server-agnostic, so you can use this library to connect to any compliant server.
 
-Tools can be exposed easily as `AIFunction` instances so that they are immediately usable with `IChatClient`s.
+Tools can be easily exposed for immediate use by `IChatClient`s, because `McpClientTool` inherits from `AIFunction`.
 
 ```csharp
 // Get available functions.
@@ -163,10 +163,10 @@ using System.Text.Json;
 
 McpServerOptions options = new()
 {
-    ServerInfo = new() { Name = "MyServer", Version = "1.0.0" },
-    Capabilities = new()
+    ServerInfo = new Implementation() { Name = "MyServer", Version = "1.0.0" },
+    Capabilities = new ServerCapabilities()
     {
-        Tools = new()
+        Tools = new ToolsCapability()
         {
             ListToolsHandler = (request, cancellationToken) =>
                 Task.FromResult(new ListToolsResult()
@@ -199,7 +199,7 @@ McpServerOptions options = new()
                 {
                     if (request.Params.Arguments?.TryGetValue("message", out var message) is not true)
                     {
-                        throw new McpServerException("Missing required argument 'message'");
+                        throw new McpException("Missing required argument 'message'");
                     }
 
                     return Task.FromResult(new CallToolResponse()
@@ -208,7 +208,7 @@ McpServerOptions options = new()
                     });
                 }
 
-                throw new McpServerException($"Unknown tool: '{request.Params?.Name}'");
+                throw new McpException($"Unknown tool: '{request.Params?.Name}'");
             },
         }
     },
@@ -220,7 +220,7 @@ await server.RunAsync();
 
 ## 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.
+The starting point for this library was a project called [mcpdotnet](https://github.com/PederHP/mcpdotnet), initiated by [Peder Holdgaard Pedersen](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
 

samples/AspNetCoreSseServer/AspNetCoreSseServer.csproj

@@ -12,4 +12,11 @@
     <ProjectReference Include="..\..\src\ModelContextProtocol.AspNetCore\ModelContextProtocol.AspNetCore.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" />
+  </ItemGroup>
+
 </Project>

samples/AspNetCoreSseServer/Program.cs

@@ -1,10 +1,24 @@
 using TestServerWithHosting.Tools;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Trace;
+using OpenTelemetry;
 
 var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddMcpServer()
+    .WithHttpTransport()
     .WithTools<EchoTool>()
     .WithTools<SampleLlmTool>();
 
+builder.Services.AddOpenTelemetry()
+    .WithTracing(b => b.AddSource("*")
+        .AddAspNetCoreInstrumentation()
+        .AddHttpClientInstrumentation())
+    .WithMetrics(b => b.AddMeter("*")
+        .AddAspNetCoreInstrumentation()
+        .AddHttpClientInstrumentation())
+    .WithLogging()
+    .UseOtlpExporter();
+
 var app = builder.Build();
 
 app.MapMcp();

samples/AspNetCoreSseServer/Properties/launchSettings.json

@@ -6,15 +6,17 @@
       "dotnetRunMessages": true,
       "applicationUrl": "http://localhost:3001",
       "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "OTEL_SERVICE_NAME": "sse-server",
       }
     },
     "https": {
       "commandName": "Project",
       "dotnetRunMessages": true,
       "applicationUrl": "https://localhost:7133;http://localhost:3001",
       "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "OTEL_SERVICE_NAME": "sse-server",
       }
     }
   }

samples/ChatWithTools/ChatWithTools.csproj

@@ -15,6 +15,8 @@
     <PackageReference Include="Microsoft.Extensions.AI" />
     <PackageReference Include="Microsoft.Extensions.AI.OpenAI" />
     <PackageReference Include="Anthropic.SDK" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" />
   </ItemGroup>
 
   <ItemGroup>

samples/ChatWithTools/Program.cs

@@ -3,15 +3,49 @@
 using Microsoft.Extensions.AI;
 using OpenAI;
 
+using OpenTelemetry;
+using OpenTelemetry.Trace;
+using Microsoft.Extensions.Logging;
+using OpenTelemetry.Logs;
+using OpenTelemetry.Metrics;
+
+using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+    .AddHttpClientInstrumentation()
+    .AddSource("*")
+    .AddOtlpExporter()
+    .Build();
+using var metricsProvider = Sdk.CreateMeterProviderBuilder()
+    .AddHttpClientInstrumentation()
+    .AddMeter("*")
+    .AddOtlpExporter()
+    .Build();
+using var loggerFactory = LoggerFactory.Create(builder => builder.AddOpenTelemetry(opt => opt.AddOtlpExporter()));
+
 // Connect to an MCP server
 Console.WriteLine("Connecting client to MCP 'everything' server");
+
+// Create OpenAI client (or any other compatible with IChatClient)
+// Provide your own OPENAI_API_KEY via an environment variable.
+var openAIClient = new OpenAIClient(Environment.GetEnvironmentVariable("OPENAI_API_KEY")).GetChatClient("gpt-4o-mini");
+
+// Create a sampling client.
+using IChatClient samplingClient = openAIClient.AsIChatClient()
+    .AsBuilder()
+    .UseOpenTelemetry(loggerFactory: loggerFactory, configure: o => o.EnableSensitiveData = true)
+    .Build();
+
 var mcpClient = await McpClientFactory.CreateAsync(
     new StdioClientTransport(new()
     {
         Command = "npx",
         Arguments = ["-y", "--verbose", "@modelcontextprotocol/server-everything"],
         Name = "Everything",
-    }));
+    }),
+    clientOptions: new()
+    {
+        Capabilities = new() { Sampling = new() { SamplingHandler = samplingClient.CreateSamplingHandler() } },
+    },
+    loggerFactory: loggerFactory);
 
 // Get all available tools
 Console.WriteLine("Tools available:");
@@ -20,13 +54,15 @@
 {
     Console.WriteLine($"  {tool}");
 }
+
 Console.WriteLine();
 
-// Create an IChatClient. (This shows using OpenAIClient, but it could be any other IChatClient implementation.)
-// Provide your own OPENAI_API_KEY via an environment variable.
-using IChatClient chatClient =
-    new OpenAIClient(Environment.GetEnvironmentVariable("OPENAI_API_KEY")).GetChatClient("gpt-4o-mini").AsIChatClient()
-    .AsBuilder().UseFunctionInvocation().Build();
+// Create an IChatClient that can use the tools.
+using IChatClient chatClient = openAIClient.AsIChatClient()
+    .AsBuilder()
+    .UseFunctionInvocation()
+    .UseOpenTelemetry(loggerFactory: loggerFactory, configure: o => o.EnableSensitiveData = true)
+    .Build();
 
 // Have a conversation, making all tools available to the LLM.
 List<ChatMessage> messages = [];

samples/EverythingServer/EverythingServer.csproj

@@ -9,6 +9,9 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Hosting" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" />
   </ItemGroup>
 
   <ItemGroup>