[#19] Add XML Documentation Comments to the Flow, Mcp, Model Contexts

Author: sgdevnet

src/MaIN.Core/Hub/Contexts/ChatContext.cs

@@ -12,7 +12,7 @@
 
 namespace MaIN.Core.Hub.Contexts;
 
-public sealed class ChatContext : IChatBuilderEntryPoint, IChatMessageBuilder, IChatCompletionBuilder
+public sealed class ChatContext : IChatBuilderEntryPoint, IChatMessageBuilder, IChatConfigurationBuilder
 {
     private readonly IChatService _chatService;
     private bool _preProcess;
@@ -58,38 +58,38 @@ public IChatMessageBuilder EnableVisual()
         return this;
     }
 
-    public IChatCompletionBuilder WithInferenceParams(InferenceParams inferenceParams)
+    public IChatConfigurationBuilder WithInferenceParams(InferenceParams inferenceParams)
     {
         _chat.InterferenceParams = inferenceParams;
         return this;
     }
 
-    public IChatCompletionBuilder WithTools(ToolsConfiguration toolsConfiguration)
+    public IChatConfigurationBuilder WithTools(ToolsConfiguration toolsConfiguration)
     {
         _chat.ToolsConfiguration = toolsConfiguration;
         return this;
     }
 
-    public IChatCompletionBuilder WithMemoryParams(MemoryParams memoryParams)
+    public IChatConfigurationBuilder WithMemoryParams(MemoryParams memoryParams)
     {
         _chat.MemoryParams = memoryParams;
         return this;
     }
 
-    public IChatCompletionBuilder Speak(TextToSpeechParams speechParams)
+    public IChatConfigurationBuilder Speak(TextToSpeechParams speechParams)
     {
         _chat.Visual = false;
         _chat.TextToSpeechParams = speechParams;
         return this;
     }
 
-    public IChatCompletionBuilder WithBackend(BackendType backendType)
+    public IChatConfigurationBuilder WithBackend(BackendType backendType)
     {
         _chat.Backend = backendType;
         return this;
     }
 
-    public IChatCompletionBuilder WithSystemPrompt(string systemPrompt)
+    public IChatConfigurationBuilder WithSystemPrompt(string systemPrompt)
     {
         var message = new Message
         {
@@ -103,13 +103,13 @@ public IChatCompletionBuilder WithSystemPrompt(string systemPrompt)
         return this;
     }
 
-    public IChatCompletionBuilder WithMessage(string content)
+    public IChatConfigurationBuilder WithMessage(string content)
     {
         _chat.Messages.Add(new Message { Role = "User", Content = content, Type = MessageType.LocalLLM, Time = DateTime.Now });
         return this;
     }
 
-    public IChatCompletionBuilder WithMessage(string content, byte[] image)
+    public IChatConfigurationBuilder WithMessage(string content, byte[] image)
     {
         var message = new Message
         {
@@ -124,28 +124,28 @@ public IChatCompletionBuilder WithMessage(string content, byte[] image)
         return this;
     }
 
-    public IChatCompletionBuilder WithMessages(IEnumerable<Message> messages)
+    public IChatConfigurationBuilder WithMessages(IEnumerable<Message> messages)
     {
         _chat.Messages.AddRange(messages);
         return this;
     }
 
-    public IChatCompletionBuilder WithFiles(List<FileStream> file, bool preProcess = false)
+    public IChatConfigurationBuilder WithFiles(List<FileStream> file, bool preProcess = false)
     {
         _files = file.Select(f => new FileInfo { Name = Path.GetFileName(f.Name), StreamContent = f, Extension = Path.GetExtension(f.Name) })
             .ToList();
         _preProcess = preProcess;
         return this;
     }
 
-    public IChatCompletionBuilder WithFiles(List<FileInfo> file, bool preProcess = false)
+    public IChatConfigurationBuilder WithFiles(List<FileInfo> file, bool preProcess = false)
     {
         _files = file;
         _preProcess = preProcess;
         return this;
     }
 
-    public IChatCompletionBuilder WithFiles(List<string> file, bool preProcess = false)
+    public IChatConfigurationBuilder WithFiles(List<string> file, bool preProcess = false)
     {
         _files = file
             .Select(path =>
@@ -160,7 +160,7 @@ public IChatCompletionBuilder WithFiles(List<string> file, bool preProcess = fal
         return this;
     }
 
-    public IChatCompletionBuilder DisableCache()
+    public IChatConfigurationBuilder DisableCache()
     {
         _chat.Properties.AddProperty(ServiceConstants.Properties.DisableCacheProperty);
         return this;
@@ -191,7 +191,7 @@ public async Task<ChatResult> CompleteAsync(
         return result;
     }
 
-    public async Task<IChatCompletionBuilder> FromExisting(string chatId)
+    public async Task<IChatConfigurationBuilder> FromExisting(string chatId)
     {
         var existing = await _chatService.GetById(chatId);
         return existing == null 

src/MaIN.Core/Hub/Contexts/FlowContext.cs

@@ -1,5 +1,6 @@
 using System.IO.Compression;
 using System.Text.Json;
+using MaIN.Core.Hub.Contexts.Interfaces.FlowContext;
 using MaIN.Domain.Configuration;
 using MaIN.Domain.Entities;
 using MaIN.Domain.Entities.Agents;
@@ -10,7 +11,7 @@
 
 namespace MaIN.Core.Hub.Contexts;
 
-public sealed class FlowContext
+public sealed class FlowContext : IFlowContext
 {
     private readonly IAgentFlowService _flowService;
     private readonly IAgentService _agentService;
@@ -36,25 +37,25 @@ internal FlowContext(IAgentFlowService flowService, IAgentService agentService,
         _flow = existingFlow;
     }
 
-    public FlowContext WithId(string id)
+    public IFlowContext WithId(string id)
     {
         _flow.Id = id;
         return this;
     }
 
-    public FlowContext WithName(string name)
+    public IFlowContext WithName(string name)
     {
         _flow.Name = name;
         return this;
     }
 
-    public FlowContext WithDescription(string description)
+    public IFlowContext WithDescription(string description)
     {
         _flow.Description = description;
         return this;
     }
 
-    public FlowContext Save(string path)
+    public IFlowContext Save(string path)
     {
         Directory.CreateDirectory(Path.GetDirectoryName(path)!);
 
@@ -84,7 +85,7 @@ public FlowContext Save(string path)
         return this;
     }
 
-    public FlowContext Load(string path)
+    public IFlowContext Load(string path)
     {
         var fileName = Path.GetFileNameWithoutExtension(path);
         string description = "";
@@ -133,7 +134,7 @@ public FlowContext Load(string path)
         return this;
     }
 
-    public FlowContext AddAgent(Agent agent)
+    public IFlowContext AddAgent(Agent agent)
     {
         _flow.Agents.Add(agent);
         return this;
@@ -190,7 +191,7 @@ public async Task<ChatResult> ProcessAsync(Message message, bool translate = fal
         };
     }
 
-    public FlowContext AddAgents(IEnumerable<Agent> agents)
+    public IFlowContext AddAgents(IEnumerable<Agent> agents)
     {
         foreach (var agent in agents)
         {
@@ -229,7 +230,7 @@ public async Task<List<AgentFlow>> GetAllFlows()
     }
 
     // Static factory methods
-    public async Task<FlowContext> FromExisting(string flowId)
+    public async Task<IFlowContext> FromExisting(string flowId)
     {
         var existingFlow = await _flowService.GetFlowById(flowId);
         return existingFlow == null

src/MaIN.Core/Hub/Contexts/Interfaces/ChatContext/IChatBuilderEntryPoint.cs

@@ -26,5 +26,5 @@ public interface IChatBuilderEntryPoint : IChatActions
     /// Loads an existing chat session from the database using its unique identifier.
     /// </summary>
     /// <param name="chatId">The GUID of the existing chat.</param>
-    Task<IChatCompletionBuilder> FromExisting(string chatId);
+    Task<IChatConfigurationBuilder> FromExisting(string chatId);
 }

…es/ChatContext/IChatCompletionBuilder.cs …ChatContext/IChatConfigurationBuilder.cssrc/MaIN.Core/Hub/Contexts/Interfaces/ChatContext/IChatCompletionBuilder.cs renamed to src/MaIN.Core/Hub/Contexts/Interfaces/ChatContext/IChatConfigurationBuilder.cs src/MaIN.Core/Hub/Contexts/Interfaces/ChatContext/IChatCompletionBuilder.cs renamed to src/MaIN.Core/Hub/Contexts/Interfaces/ChatContext/IChatConfigurationBuilder.cs

@@ -7,69 +7,70 @@
 
 namespace MaIN.Core.Hub.Contexts.Interfaces.ChatContext;
 
-public interface IChatCompletionBuilder : IChatActions
+public interface IChatConfigurationBuilder : IChatActions
 {
     /// <summary>
     /// Configures low-level LLM parameters like temperature, context size, max tokens etc.
     /// </summary>
     /// <param name="inferenceParams">An object containing detailed inference settings for the LLM.</param>
-    IChatCompletionBuilder WithInferenceParams(InferenceParams inferenceParams);
+    IChatConfigurationBuilder WithInferenceParams(InferenceParams inferenceParams);
 
     /// <summary>
     /// Attaches external tools/functions that the model can invoke during the conversation.
     /// </summary>
     /// <param name="toolsConfiguration">Configuration defining available tools and their execution modes.</param>
-    IChatCompletionBuilder WithTools(ToolsConfiguration toolsConfiguration);
+    IChatConfigurationBuilder WithTools(ToolsConfiguration toolsConfiguration);
 
     /// <summary>
     /// Defines memory parameters for the chat.
     /// </summary>
     /// <param name="memoryParams">Configuration for how the chat context and memory should be handled.</param>
-    IChatCompletionBuilder WithMemoryParams(MemoryParams memoryParams);
+    IChatConfigurationBuilder WithMemoryParams(MemoryParams memoryParams);
 
     /// <summary>
     /// Configures the session to use Text-to-Speech for the model's responses.
     /// </summary>
     /// <param name="speechParams">Parameters for the voice synthesis.</param>
-    IChatCompletionBuilder Speak(TextToSpeechParams speechParams);
+    IChatConfigurationBuilder Speak(TextToSpeechParams speechParams);
 
     /// <summary>
     /// Sets the specific execution backend for the inference (e.g., Local, Cloud).
     /// </summary>
     /// <param name="backendType">The type of backend to be used for processing the request.</param>
-    IChatCompletionBuilder WithBackend(BackendType backendType);
+    IChatConfigurationBuilder WithBackend(BackendType backendType);
 
     /// <summary>
     /// Sets a system-level prompt to guide the model's behavior, persona, and constraints.
     /// </summary>
     /// <param name="systemPrompt">The text content of the system instructions.</param>
-    IChatCompletionBuilder WithSystemPrompt(string systemPrompt);
+    IChatConfigurationBuilder WithSystemPrompt(string systemPrompt);
 
     /// <summary>
     /// Attaches a list of files provided as <see cref="FileStream"/> to the message context.
     /// </summary>
     /// <param name="file">A list of open file streams to be uploaded or analyzed.</param>
     /// <param name="preProcess">If true, the files will be pre-processed (e.g., indexed) before sending.</param>
-    IChatCompletionBuilder WithFiles(List<FileStream> file, bool preProcess = false);
+    IChatConfigurationBuilder WithFiles(List<FileStream> file, bool preProcess = false);
 
     /// <summary>
     /// Attaches a list of files provided as <see cref="FileInfo"/> objects to the message context.
     /// </summary>
     /// <param name="file">A list of file metadata and content references.</param>
     /// <param name="preProcess">If true, the files will be pre-processed (e.g., indexed) before sending.</param>
-    IChatCompletionBuilder WithFiles(List<FileInfo> file, bool preProcess = false);
+    IChatConfigurationBuilder WithFiles(List<FileInfo> file, bool preProcess = false);
 
     /// <summary>
     /// Attaches a list of files from provided local system paths to the message context.
     /// </summary>
     /// <param name="file">A list of absolute or relative paths to the files.</param>
     /// <param name="preProcess">If true, the files will be pre-processed (e.g., indexed) before sending.</param>
-    IChatCompletionBuilder WithFiles(List<string> file, bool preProcess = false);
+    /// <returns>The builder instance implementing <see cref="IChatConfigurationBuilder"/> to enable method chaining.</returns>
+    IChatConfigurationBuilder WithFiles(List<string> file, bool preProcess = false);
 
     /// <summary>
     /// Disables the internal caching mechanism for the upcoming request.
     /// </summary>
-    IChatCompletionBuilder DisableCache();
+    IChatConfigurationBuilder DisableCache();
 
     /// <summary>
     /// Sends the configured chat context to the service for completion.

src/MaIN.Core/Hub/Contexts/Interfaces/ChatContext/IChatMessageBuilder.cs

@@ -13,18 +13,18 @@ public interface IChatMessageBuilder : IChatActions
     /// Adds a single text message to the chat context.
     /// </summary>
     /// <param name="content">The text content of the message.</param>
-    IChatCompletionBuilder WithMessage(string content);
+    IChatConfigurationBuilder WithMessage(string content);
 
     /// <summary>
     /// Adds a message containing both text and image data.
     /// </summary>
     /// <param name="content">The text description or prompt.</param>
     /// <param name="image">The byte array containing image data.</param>
-    IChatCompletionBuilder WithMessage(string content, byte[] image);
+    IChatConfigurationBuilder WithMessage(string content, byte[] image);
 
     /// <summary>
     /// Appends a collection of messages to the chat.
     /// </summary>
     /// <param name="messages">An enumerable list of message objects.</param>
-    IChatCompletionBuilder WithMessages(IEnumerable<Message> messages);
+    IChatConfigurationBuilder WithMessages(IEnumerable<Message> messages);
 }