Add MCP endpoint for audit and failed messages

src/Directory.Packages.props

@@ -82,6 +82,7 @@
     <PackageVersion Include="System.Reflection.MetadataLoadContext" Version="10.0.5" />
     <PackageVersion Include="System.ServiceProcess.ServiceController" Version="10.0.5" />
     <PackageVersion Include="Validar.Fody" Version="1.9.0" />
+    <PackageVersion Include="ModelContextProtocol.AspNetCore" Version="1.1.0" />
     <PackageVersion Include="Yarp.ReverseProxy" Version="2.3.0" />
   </ItemGroup>
   <ItemGroup Label="Versions to pin transitive references">

src/ServiceControl.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs

@@ -125,7 +125,7 @@ async Task InitializeServiceControl(ScenarioContext context)
                 hostBuilder.AddServiceControlAuthentication(settings.OpenIdConnectSettings);
                 hostBuilder.AddServiceControl(settings, configuration);
                 hostBuilder.AddServiceControlHttps(settings.HttpsSettings);
-                hostBuilder.AddServiceControlApi(settings.CorsSettings);
+                hostBuilder.AddServiceControlApi(settings);
 
                 hostBuilder.AddServiceControlTesting(settings);
 
@@ -135,7 +135,7 @@ async Task InitializeServiceControl(ScenarioContext context)
 
                 host.UseTestRemoteIp();
                 host.UseServiceControlAuthentication(settings.OpenIdConnectSettings.Enabled);
-                host.UseServiceControl(settings.ForwardedHeadersSettings, settings.HttpsSettings);
+                host.UseServiceControl(settings.ForwardedHeadersSettings, settings.HttpsSettings, settings.EnableMcpServer);
                 await host.StartAsync();
                 DomainEvents = host.Services.GetRequiredService<IDomainEvents>();
                 // Bring this back and look into the base address of the client

src/ServiceControl.Audit.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs

@@ -133,7 +133,7 @@ async Task InitializeServiceControl(ScenarioContext context)
                     return criticalErrorContext.Stop(cancellationToken);
                 }, settings, configuration);
 
-                hostBuilder.AddServiceControlAuditApi(settings.CorsSettings);
+                hostBuilder.AddServiceControlAuditApi(settings);
                 hostBuilder.AddServiceControlHttps(settings.HttpsSettings);
 
                 hostBuilder.AddServiceControlAuditTesting(settings);
@@ -144,7 +144,7 @@ async Task InitializeServiceControl(ScenarioContext context)
 
                 host.UseTestRemoteIp();
                 host.UseServiceControlAuthentication(settings.OpenIdConnectSettings.Enabled);
-                host.UseServiceControlAudit(settings.ForwardedHeadersSettings, settings.HttpsSettings);
+                host.UseServiceControlAudit(settings.ForwardedHeadersSettings, settings.HttpsSettings, settings.EnableMcpServer);
                 await host.StartAsync();
                 ServiceProvider = host.Services;
                 InstanceTestServer = host.GetTestServer();

src/ServiceControl.Audit.UnitTests/ApprovalFiles/APIApprovals.PlatformSampleSettings.approved.txt

@@ -58,5 +58,6 @@
   "ServiceControlQueueAddress": "Particular.ServiceControl",
   "TimeToRestartAuditIngestionAfterFailure": "00:01:00",
   "EnableFullTextSearchOnBodies": true,
+  "EnableMcpServer": false,
   "ShutdownTimeout": "00:00:05"
 }

src/ServiceControl.Audit/App.config

@@ -8,6 +8,8 @@ These settings are only here so that we can debug ServiceControl while developin
     <add key="ServiceControl.Audit/ServiceControlQueueAddress" value="Particular.ServiceControl" />
     <add key="ServiceControl.Audit/HostName" value="localhost" />
     <add key="ServiceControl.Audit/DatabaseMaintenancePort" value="44445" />
+    <add key="ServiceControl.Audit/EnableMcpServer" value="false"/>
+
     <!-- DEVS - Pick a transport to run Auditing instance on -->
     <add key="ServiceControl.Audit/TransportType" value="LearningTransport" />
     <!--<add key="ServiceControl.Audit/TransportType" value="AmazonSQS" />-->

src/ServiceControl.Audit/Infrastructure/Hosting/Commands/RunCommand.cs

@@ -25,10 +25,10 @@ public override async Task Execute(HostArguments args, Settings settings)
                 //Do nothing. The transports in NSB 8 are designed to handle broker outages. Audit ingestion will be paused when broker is unavailable.
                 return Task.CompletedTask;
             }, settings, endpointConfiguration);
-            hostBuilder.AddServiceControlAuditApi(settings.CorsSettings);
+            hostBuilder.AddServiceControlAuditApi(settings);
 
             var app = hostBuilder.Build();
-            app.UseServiceControlAudit(settings.ForwardedHeadersSettings, settings.HttpsSettings);
+            app.UseServiceControlAudit(settings.ForwardedHeadersSettings, settings.HttpsSettings, settings.EnableMcpServer);
             app.UseServiceControlAuthentication(settings.OpenIdConnectSettings.Enabled);
 
             await app.RunAsync(settings.RootUrl);

src/ServiceControl.Audit/Infrastructure/Settings/Settings.cs

@@ -54,6 +54,7 @@ public Settings(string transportType = null, string persisterType = null, Loggin
             ServiceControlQueueAddress = SettingsReader.Read<string>(SettingsRootNamespace, "ServiceControlQueueAddress");
             TimeToRestartAuditIngestionAfterFailure = GetTimeToRestartAuditIngestionAfterFailure();
             EnableFullTextSearchOnBodies = SettingsReader.Read(SettingsRootNamespace, "EnableFullTextSearchOnBodies", true);
+            EnableMcpServer = SettingsReader.Read(SettingsRootNamespace, "EnableMcpServer", false);
             ShutdownTimeout = SettingsReader.Read(SettingsRootNamespace, "ShutdownTimeout", ShutdownTimeout);
 
             AssemblyLoadContextResolver = static assemblyPath => new PluginAssemblyLoadContext(assemblyPath);
@@ -187,6 +188,8 @@ public int MaxBodySizeToStore
 
         public bool EnableFullTextSearchOnBodies { get; set; }
 
+        public bool EnableMcpServer { get; set; }
+
         // The default value is set to the maximum allowed time by the most
         // restrictive hosting platform, which is Linux containers. Linux
         // containers allow for a maximum of 10 seconds. We set it to 5 to

src/ServiceControl.Audit/Infrastructure/WebApi/HostApplicationBuilderExtensions.cs

@@ -4,13 +4,22 @@
     using Microsoft.AspNetCore.Builder;
     using Microsoft.Extensions.DependencyInjection;
     using Microsoft.Extensions.Hosting;
+    using ModelContextProtocol.AspNetCore;
     using ServiceControl.Infrastructure;
 
     static class HostApplicationBuilderExtensions
     {
-        public static void AddServiceControlAuditApi(this IHostApplicationBuilder builder, CorsSettings corsSettings)
+        public static void AddServiceControlAuditApi(this IHostApplicationBuilder builder, Settings.Settings settings)
         {
-            builder.Services.AddCors(options => options.AddDefaultPolicy(Cors.GetDefaultPolicy(corsSettings)));
+            if (settings.EnableMcpServer)
+            {
+                builder.Services
+                    .AddMcpServer()
+                    .WithHttpTransport()
+                    .WithToolsFromAssembly();
+            }
+
+            builder.Services.AddCors(options => options.AddDefaultPolicy(Cors.GetDefaultPolicy(settings.CorsSettings)));
 
             // We're not explicitly adding Gzip here because it's already in the default list of supported compressors
             builder.Services.AddResponseCompression();

src/ServiceControl.Audit/Mcp/AuditMessageTools.cs

@@ -0,0 +1,147 @@
+#nullable enable
+
+namespace ServiceControl.Audit.Mcp;
+
+using System.ComponentModel;
+using System.Text.Json;
+using System.Threading;
+using System.Threading.Tasks;
+using Infrastructure;
+using ModelContextProtocol.Server;
+using Persistence;
+
+[McpServerToolType]
+public class AuditMessageTools(IAuditDataStore store)
+{
+    [McpServerTool, Description("Get a list of successfully processed audit messages. Supports paging and sorting. Returns message metadata including endpoints, timing information, and message type.")]
+    public async Task<string> GetAuditMessages(
+        [Description("Whether to include system messages in results. Default is false")] bool includeSystemMessages = false,
+        [Description("Page number (1-based). Default is 1")] int page = 1,
+        [Description("Number of results per page. Default is 50")] int perPage = 50,
+        [Description("Sort field: time_sent, processed_at, message_type, critical_time, delivery_time, processing_time. Default is time_sent")] string sort = "time_sent",
+        [Description("Sort direction: asc or desc. Default is desc")] string direction = "desc",
+        [Description("Filter by time sent start (ISO 8601 format)")] string? timeSentFrom = null,
+        [Description("Filter by time sent end (ISO 8601 format)")] string? timeSentTo = null,
+        CancellationToken cancellationToken = default)
+    {
+        var pagingInfo = new PagingInfo(page, perPage);
+        var sortInfo = new SortInfo(sort, direction);
+        var timeSentRange = new DateTimeRange(timeSentFrom, timeSentTo);
+
+        var results = await store.GetMessages(includeSystemMessages, pagingInfo, sortInfo, timeSentRange, cancellationToken);
+
+        return JsonSerializer.Serialize(new
+        {
+            results.QueryStats.TotalCount,
+            results.Results
+        }, McpJsonOptions.Default);
+    }
+
+    [McpServerTool, Description("Search audit messages by a keyword or phrase. Searches across message content and metadata.")]
+    public async Task<string> SearchAuditMessages(
+        [Description("The search query string")] string query,
+        [Description("Page number (1-based). Default is 1")] int page = 1,
+        [Description("Number of results per page. Default is 50")] int perPage = 50,
+        [Description("Sort field: time_sent, processed_at, message_type, critical_time, delivery_time, processing_time. Default is time_sent")] string sort = "time_sent",
+        [Description("Sort direction: asc or desc. Default is desc")] string direction = "desc",
+        [Description("Filter by time sent start (ISO 8601 format)")] string? timeSentFrom = null,
+        [Description("Filter by time sent end (ISO 8601 format)")] string? timeSentTo = null,
+        CancellationToken cancellationToken = default)
+    {
+        var pagingInfo = new PagingInfo(page, perPage);
+        var sortInfo = new SortInfo(sort, direction);
+        var timeSentRange = new DateTimeRange(timeSentFrom, timeSentTo);
+
+        var results = await store.QueryMessages(query, pagingInfo, sortInfo, timeSentRange, cancellationToken);
+
+        return JsonSerializer.Serialize(new
+        {
+            results.QueryStats.TotalCount,
+            results.Results
+        }, McpJsonOptions.Default);
+    }
+
+    [McpServerTool, Description("Get audit messages received by a specific endpoint. Can optionally filter by keyword.")]
+    public async Task<string> GetAuditMessagesByEndpoint(
+        [Description("The name of the receiving endpoint")] string endpointName,
+        [Description("Optional keyword to filter messages")] string? keyword = null,
+        [Description("Whether to include system messages in results. Default is false")] bool includeSystemMessages = false,
+        [Description("Page number (1-based). Default is 1")] int page = 1,
+        [Description("Number of results per page. Default is 50")] int perPage = 50,
+        [Description("Sort field: time_sent, processed_at, message_type, critical_time, delivery_time, processing_time. Default is time_sent")] string sort = "time_sent",
+        [Description("Sort direction: asc or desc. Default is desc")] string direction = "desc",
+        [Description("Filter by time sent start (ISO 8601 format)")] string? timeSentFrom = null,
+        [Description("Filter by time sent end (ISO 8601 format)")] string? timeSentTo = null,
+        CancellationToken cancellationToken = default)
+    {
+        var pagingInfo = new PagingInfo(page, perPage);
+        var sortInfo = new SortInfo(sort, direction);
+        var timeSentRange = new DateTimeRange(timeSentFrom, timeSentTo);
+
+        var results = keyword != null
+            ? await store.QueryMessagesByReceivingEndpointAndKeyword(endpointName, keyword, pagingInfo, sortInfo, timeSentRange, cancellationToken)
+            : await store.QueryMessagesByReceivingEndpoint(includeSystemMessages, endpointName, pagingInfo, sortInfo, timeSentRange, cancellationToken);
+
+        return JsonSerializer.Serialize(new
+        {
+            results.QueryStats.TotalCount,
+            results.Results
+        }, McpJsonOptions.Default);
+    }
+
+    [McpServerTool, Description("Get all audit messages that belong to a specific conversation. A conversation groups related messages that were triggered by the same initial message.")]
+    public async Task<string> GetAuditMessagesByConversation(
+        [Description("The conversation ID to filter by")] string conversationId,
+        [Description("Page number (1-based). Default is 1")] int page = 1,
+        [Description("Number of results per page. Default is 50")] int perPage = 50,
+        [Description("Sort field: time_sent, processed_at, message_type, critical_time, delivery_time, processing_time. Default is time_sent")] string sort = "time_sent",
+        [Description("Sort direction: asc or desc. Default is desc")] string direction = "desc",
+        CancellationToken cancellationToken = default)
+    {
+        var pagingInfo = new PagingInfo(page, perPage);
+        var sortInfo = new SortInfo(sort, direction);
+
+        var results = await store.QueryMessagesByConversationId(conversationId, pagingInfo, sortInfo, cancellationToken);
+
+        return JsonSerializer.Serialize(new
+        {
+            results.QueryStats.TotalCount,
+            results.Results
+        }, McpJsonOptions.Default);
+    }
+
+    [McpServerTool, Description("Get the body content of a specific audit message by its message ID.")]
+    public async Task<string> GetAuditMessageBody(
+        [Description("The message ID")] string messageId,
+        CancellationToken cancellationToken = default)
+    {
+        var result = await store.GetMessageBody(messageId, cancellationToken);
+
+        if (!result.Found)
+        {
+            return JsonSerializer.Serialize(new { Error = $"Message '{messageId}' not found." }, McpJsonOptions.Default);
+        }
+
+        if (!result.HasContent)
+        {
+            return JsonSerializer.Serialize(new { Error = $"Message '{messageId}' has no body content." }, McpJsonOptions.Default);
+        }
+
+        if (result.StringContent != null)
+        {
+            return JsonSerializer.Serialize(new
+            {
+                result.ContentType,
+                result.ContentLength,
+                Body = result.StringContent
+            }, McpJsonOptions.Default);
+        }
+
+        return JsonSerializer.Serialize(new
+        {
+            result.ContentType,
+            result.ContentLength,
+            Body = "(stream content - not available as text)"
+        }, McpJsonOptions.Default);
+    }
+}

src/ServiceControl.Audit/Mcp/EndpointTools.cs

@@ -0,0 +1,40 @@
+#nullable enable
+
+namespace ServiceControl.Audit.Mcp;
+
+using System.ComponentModel;
+using System.Text.Json;
+using System.Threading;
+using System.Threading.Tasks;
+using ModelContextProtocol.Server;
+using Persistence;
+
+[McpServerToolType]
+public class EndpointTools(IAuditDataStore store)
+{
+    [McpServerTool, Description("Get a list of all known endpoints that have sent or received audit messages.")]
+    public async Task<string> GetKnownEndpoints(CancellationToken cancellationToken = default)
+    {
+        var results = await store.QueryKnownEndpoints(cancellationToken);
+
+        return JsonSerializer.Serialize(new
+        {
+            results.QueryStats.TotalCount,
+            results.Results
+        }, McpJsonOptions.Default);
+    }
+
+    [McpServerTool, Description("Get audit message counts per day for a specific endpoint. Useful for understanding message throughput.")]
+    public async Task<string> GetEndpointAuditCounts(
+        [Description("The name of the endpoint")] string endpointName,
+        CancellationToken cancellationToken = default)
+    {
+        var results = await store.QueryAuditCounts(endpointName, cancellationToken);
+
+        return JsonSerializer.Serialize(new
+        {
+            results.QueryStats.TotalCount,
+            results.Results
+        }, McpJsonOptions.Default);
+    }
+}

src/ServiceControl.Audit/Mcp/McpJsonOptions.cs

@@ -0,0 +1,16 @@
+#nullable enable
+
+namespace ServiceControl.Audit.Mcp;
+
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+static class McpJsonOptions
+{
+    public static JsonSerializerOptions Default { get; } = new()
+    {
+        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+        DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+        WriteIndented = false
+    };
+}

src/ServiceControl.Audit/ServiceControl.Audit.csproj

@@ -26,6 +26,7 @@
   <ItemGroup>
     <PackageReference Include="ByteSize" />
     <PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" />
+    <PackageReference Include="ModelContextProtocol.AspNetCore" />
     <PackageReference Include="NServiceBus.CustomChecks" />
     <PackageReference Include="NServiceBus.Extensions.Hosting" />
     <PackageReference Include="NServiceBus.Extensions.Logging" />

src/ServiceControl.Audit/WebApplicationExtensions.cs

@@ -8,7 +8,7 @@ namespace ServiceControl.Audit;
 
 public static class WebApplicationExtensions
 {
-    public static void UseServiceControlAudit(this WebApplication app, ForwardedHeadersSettings forwardedHeadersSettings, HttpsSettings httpsSettings)
+    public static void UseServiceControlAudit(this WebApplication app, ForwardedHeadersSettings forwardedHeadersSettings, HttpsSettings httpsSettings, bool enableMcpServer)
     {
         app.UseServiceControlForwardedHeaders(forwardedHeadersSettings);
         app.UseServiceControlHttps(httpsSettings);
@@ -17,5 +17,10 @@ public static void UseServiceControlAudit(this WebApplication app, ForwardedHead
         app.UseHttpLogging();
         app.UseCors();
         app.MapControllers();
+
+        if (enableMcpServer)
+        {
+            app.MapMcp("/mcp");
+        }
     }
 }

src/ServiceControl.UnitTests/ApprovalFiles/APIApprovals.PlatformSampleSettings.approved.txt

@@ -37,6 +37,7 @@
   },
   "NotificationsFilter": null,
   "AllowMessageEditing": false,
+  "EnableMcpServer": false,
   "EnableIntegratedServicePulse": false,
   "ServicePulseSettings": null,
   "MessageFilter": null,

src/ServiceControl/App.config

@@ -5,6 +5,8 @@ These settings are only here so that we can debug ServiceControl while developin
 -->
 <configuration>
   <appSettings>
+    <add key="ServiceControl/EnableMcpServer" value="false"/>
+
     <add key="ServiceControl/ForwardErrorMessages" value="false" />
     <add key="ServiceControl/ErrorRetentionPeriod" value="10.00:00:00" />
     <add key="ServiceControl/RemoteInstances" value="[{&quot;api_uri&quot;:&quot;http://localhost:44444/api/&quot;}]" />

src/ServiceControl/Hosting/Commands/ImportFailedErrorsCommand.cs

@@ -26,7 +26,7 @@ public override async Task Execute(HostArguments args, Settings settings)
 
             var hostBuilder = Host.CreateApplicationBuilder();
             hostBuilder.AddServiceControl(settings, endpointConfiguration);
-            hostBuilder.AddServiceControlApi(settings.CorsSettings);
+            hostBuilder.AddServiceControlApi(settings);
 
             using var app = hostBuilder.Build();
             await app.StartAsync();

src/ServiceControl/Hosting/Commands/RunCommand.cs

@@ -27,10 +27,10 @@ public override async Task Execute(HostArguments args, Settings settings)
             hostBuilder.AddServiceControlAuthentication(settings.OpenIdConnectSettings);
             hostBuilder.AddServiceControlHttps(settings.HttpsSettings);
             hostBuilder.AddServiceControl(settings, endpointConfiguration);
-            hostBuilder.AddServiceControlApi(settings.CorsSettings);
+            hostBuilder.AddServiceControlApi(settings);
 
             var app = hostBuilder.Build();
-            app.UseServiceControl(settings.ForwardedHeadersSettings, settings.HttpsSettings);
+            app.UseServiceControl(settings.ForwardedHeadersSettings, settings.HttpsSettings, settings.EnableMcpServer);
             if (settings.EnableIntegratedServicePulse)
             {
                 app.UseServicePulse(settings.ServicePulseSettings);