Enhance XML documentation across various tools

Author: willibrandon

src/NetContextServer/Models/IgnorePatternsResponse.cs

@@ -0,0 +1,22 @@
+namespace NetContextServer.Models;
+
+/// <summary>
+/// Response model for ignore pattern operations containing default, user-defined, and combined patterns.
+/// </summary>
+public class IgnorePatternsResponse
+{
+    /// <summary>
+    /// Gets or sets the default ignore patterns that are always active.
+    /// </summary>
+    public string[] DefaultPatterns { get; set; } = [];
+
+    /// <summary>
+    /// Gets or sets the user-defined ignore patterns.
+    /// </summary>
+    public string[] UserPatterns { get; set; } = [];
+
+    /// <summary>
+    /// Gets or sets all active ignore patterns (both default and user-defined).
+    /// </summary>
+    public string[] AllPatterns { get; set; } = [];
+} 

src/NetContextServer/Services/IgnorePatternService.cs

@@ -241,25 +241,4 @@ public static bool ShouldIgnoreFile(string filePath)
             return Path.GetFileName(filePath).Equals(pattern, StringComparison.OrdinalIgnoreCase);
         });
     }
-
-    /// <summary>
-    /// Response model for ignore pattern operations containing default, user-defined, and combined patterns.
-    /// </summary>
-    private class IgnorePatternsResponse
-    {
-        /// <summary>
-        /// Gets or sets the default ignore patterns that are always active.
-        /// </summary>
-        public string[] DefaultPatterns { get; set; } = [];
-
-        /// <summary>
-        /// Gets or sets the user-defined ignore patterns.
-        /// </summary>
-        public string[] UserPatterns { get; set; } = [];
-
-        /// <summary>
-        /// Gets or sets all active ignore patterns (both default and user-defined).
-        /// </summary>
-        public string[] AllPatterns { get; set; } = [];
-    }
 }

src/NetContextServer/Tools/FileTools.cs

@@ -5,55 +5,96 @@
 
 namespace NetContextServer.Tools;
 
+/// <summary>
+/// Provides MCP tools for file system operations, including file listing, project discovery, and file access.
+/// </summary>
 [McpToolType]
 public static class FileTools
 {
-    // Shared JsonSerializerOptions instance to improve performance
+    /// <summary>
+    /// Default JSON serializer options used across all file tools.
+    /// </summary>
     private static readonly JsonSerializerOptions DefaultJsonOptions = new()
     {
         WriteIndented = true
     };
 
+    /// <summary>
+    /// Standard error message for directory not found scenarios.
+    /// </summary>
     private static readonly string[] ErrorDirectoryNotFound = ["Error: Directory not found"];
 
+    /// <summary>
+    /// Lists all .NET source files in the specified project directory.
+    /// </summary>
+    /// <param name="projectPath">Absolute path to the project directory containing the .cs files.</param>
+    /// <returns>A JSON string containing an array of file paths.</returns>
     [McpTool("list_files")]
     [Description("Lists all .NET source files in the specified project directory.")]
     public static string ListFiles(
         [Description("Absolute path to the project directory containing the .cs files")]
         string projectPath) =>
         JsonSerializer.Serialize(FileService.ListFiles(projectPath), DefaultJsonOptions);
 
+    /// <summary>
+    /// Scans the current solution and returns all .csproj files found.
+    /// </summary>
+    /// <returns>A JSON string containing an array of project file paths.</returns>
     [McpTool("list_projects")]
     [Description("Scans the current solution and returns all .csproj files found.")]
     public static string ListProjects() => 
         JsonSerializer.Serialize(FileService.ListProjects(), DefaultJsonOptions);
 
+    /// <summary>
+    /// Searches a specific directory for .csproj files.
+    /// </summary>
+    /// <param name="directory">Absolute path to the directory to search for .csproj files.</param>
+    /// <returns>A JSON string containing an array of project file paths.</returns>
     [McpTool("list_projects_in_dir")]
     [Description("Searches a specific directory for .csproj files.")]
     public static string ListProjectsInDirectory(
         [Description("Absolute path to the directory to search for .csproj files")]
         string directory) => 
         JsonSerializer.Serialize(FileService.ListProjectsInDirectory(directory), DefaultJsonOptions);
 
+    /// <summary>
+    /// Returns all .sln files found in the base directory.
+    /// </summary>
+    /// <returns>A JSON string containing an array of solution file paths.</returns>
     [McpTool("list_solutions")]
     [Description("Returns all .sln files found in the base directory.")]
     public static string ListSolutions() => 
         JsonSerializer.Serialize(FileService.ListSolutions(), DefaultJsonOptions);
 
+    /// <summary>
+    /// Lists all source files in a project directory.
+    /// </summary>
+    /// <param name="projectDir">Absolute path to the project directory to scan for source files.</param>
+    /// <returns>A JSON string containing an array of source file paths.</returns>
     [McpTool("list_source_files")]
     [Description("Lists all source files in a project directory.")]
     public static string ListSourceFiles(
         [Description("Absolute path to the project directory to scan for source files")]
         string projectDir) => 
         JsonSerializer.Serialize(FileService.ListSourceFiles(projectDir), DefaultJsonOptions);
 
+    /// <summary>
+    /// Reads and returns the contents of a specified file.
+    /// </summary>
+    /// <param name="filePath">Absolute path to the file to read.</param>
+    /// <returns>The contents of the file, or an error message if the file cannot be read.</returns>
     [McpTool("open_file")]
     [Description("Reads and returns the contents of a specified file.")]
     public static string OpenFile(
         [Description("Absolute path to the file to read")]
         string filePath) => 
         FileService.OpenFile(filePath);
 
+    /// <summary>
+    /// Sets the base directory for all file operations.
+    /// </summary>
+    /// <param name="directory">Absolute path to set as the new base directory. Must be a valid, existing directory.</param>
+    /// <returns>A JSON string containing a confirmation message or an error message.</returns>
     [McpTool("set_base_directory")]
     [Description("Sets the base directory for all file operations.")]
     public static string SetBaseDirectory(
@@ -70,6 +111,10 @@ public static string SetBaseDirectory(
         return JsonSerializer.Serialize(new[] { $"Base directory set to: {directory}" }, DefaultJsonOptions);
     }
 
+    /// <summary>
+    /// Returns the current base directory used for all file operations.
+    /// </summary>
+    /// <returns>A JSON string containing the current base directory and whether it exists.</returns>
     [McpTool("get_base_directory")]
     [Description("Returns the current base directory used for all file operations.")]
     public static string GetBaseDirectory()
@@ -90,4 +135,4 @@ public static string GetBaseDirectory()
             return JsonSerializer.Serialize(new { Error = ex.Message }, DefaultJsonOptions);
         }
     }
-} 
+}

src/NetContextServer/Tools/GeneralTools.cs

@@ -1,13 +1,19 @@
-using ModelContextProtocol;
 using ModelContextProtocol.Server;
 using System.ComponentModel;
 
 namespace NetContextServer.Tools;
 
+/// <summary>
+/// Provides general utility tools for the MCP server.
+/// </summary>
 [McpToolType]
 public static class GeneralTools
 {
+    /// <summary>
+    /// Simple health check endpoint that returns a greeting message.
+    /// </summary>
+    /// <returns>A greeting message indicating the server is operational.</returns>
     [McpTool("hello")]
     [Description("Simple health check endpoint that returns a greeting message.")]
     public static string Hello() => "hello, claude.";
-} 
+}

src/NetContextServer/Tools/IgnorePatternTools.cs

@@ -1,35 +1,59 @@
-using ModelContextProtocol;
 using ModelContextProtocol.Server;
 using NetContextServer.Services;
 using System.ComponentModel;
 
 namespace NetContextServer.Tools;
 
+/// <summary>
+/// Provides MCP tools for managing file ignore patterns used during file operations.
+/// </summary>
 [McpToolType]
 public static class IgnorePatternTools
 {
+    /// <summary>
+    /// Adds new patterns to the ignore list for file scanning operations.
+    /// </summary>
+    /// <param name="patterns">Array of glob patterns to ignore (e.g. ['*.generated.cs', 'bin/*']).</param>
+    /// <returns>A JSON string containing the results of the operation, including any invalid patterns.</returns>
     [McpTool("add_ignore_patterns")]
     [Description("Adds new patterns to the ignore list for file scanning operations.")]
     public static string AddIgnorePatterns(
         [Description("Array of glob patterns to ignore (e.g. ['*.generated.cs', 'bin/*'])")]
         string[] patterns) =>
         IgnorePatternService.AddIgnorePatterns(patterns);
 
+    /// <summary>
+    /// Removes all user-defined ignore patterns from both memory and the persistent state file.
+    /// </summary>
+    /// <returns>A JSON string containing the updated pattern lists after clearing.</returns>
     [McpTool("clear_ignore_patterns")]
     [Description("Removes all user-defined ignore patterns from both memory and the persistent state file.")]
     public static string ClearIgnorePatterns() => 
         IgnorePatternService.ClearIgnorePatterns();
 
+    /// <summary>
+    /// Retrieves the current list of active ignore patterns from memory.
+    /// </summary>
+    /// <returns>A JSON string containing all active ignore patterns, including both default and user-defined patterns.</returns>
     [McpTool("get_ignore_patterns")]
     [Description("Retrieves the current list of active ignore patterns from memory.")]
     public static string GetIgnorePatterns() => 
         IgnorePatternService.GetIgnorePatterns();
 
+    /// <summary>
+    /// Returns the absolute path to the ignore_patterns.json state file.
+    /// </summary>
+    /// <returns>A JSON string containing the path to the state file.</returns>
     [McpTool("get_state_file_location")]
     [Description("Returns the absolute path to the ignore_patterns.json state file.")]
     public static string GetStateFileLocation() => 
         IgnorePatternService.GetStateFileLocation();
 
+    /// <summary>
+    /// Removes specific patterns from the ignore list.
+    /// </summary>
+    /// <param name="patterns">Array of glob patterns to remove from the ignore list.</param>
+    /// <returns>A JSON string containing the results of the operation and updated pattern lists.</returns>
     [McpTool("remove_ignore_patterns")]
     [Description("Removes specific patterns from the ignore list.")]
     public static string RemoveIgnorePatterns(

src/NetContextServer/Tools/PackageTools.cs

@@ -1,4 +1,3 @@
-using ModelContextProtocol;
 using ModelContextProtocol.Server;
 using NetContextServer.Models;
 using NetContextServer.Services;
@@ -7,14 +6,33 @@
 
 namespace NetContextServer.Tools;
 
+/// <summary>
+/// Provides MCP tools for analyzing NuGet packages in .NET projects.
+/// </summary>
 [McpToolType]
 public static class PackageTools
 {
+    /// <summary>
+    /// Default JSON serializer options used for package analysis output.
+    /// </summary>
     private static readonly JsonSerializerOptions DefaultJsonOptions = new()
     {
         WriteIndented = true
     };
 
+    /// <summary>
+    /// Analyzes NuGet packages in all projects found in the base directory.
+    /// </summary>
+    /// <returns>
+    /// A JSON string containing analysis results for each project, including:
+    /// - Package versions and available updates
+    /// - Usage analysis
+    /// - Recommendations for updates or removal
+    /// </returns>
+    /// <remarks>
+    /// This operation requires the base directory to be set and contain valid .NET projects.
+    /// The analysis includes checking for updates, detecting package usage, and providing recommendations.
+    /// </remarks>
     [McpTool("analyze_packages")]
     [Description("Analyzes NuGet packages in all projects found in the base directory.")]
     public static async Task<string> AnalyzePackagesAsync()
@@ -60,4 +78,4 @@ public static async Task<string> AnalyzePackagesAsync()
             return JsonSerializer.Serialize(new { Error = ex.Message }, DefaultJsonOptions);
         }
     }
-} 
+}

src/NetContextServer/Tools/SearchTools.cs

@@ -1,26 +1,46 @@
-using ModelContextProtocol;
 using ModelContextProtocol.Server;
 using NetContextServer.Services;
 using System.ComponentModel;
 using System.Text.Json;
 
 namespace NetContextServer.Tools;
 
+/// <summary>
+/// Provides MCP tools for searching code within the codebase using both text-based and semantic search capabilities.
+/// </summary>
 [McpToolType]
 public static class SearchTools
 {
+    /// <summary>
+    /// Default JSON serializer options used for search results output.
+    /// </summary>
     private static readonly JsonSerializerOptions DefaultJsonOptions = new()
     {
         WriteIndented = true
     };
 
+    /// <summary>
+    /// Performs a text-based search across all code files for the specified text.
+    /// </summary>
+    /// <param name="searchText">The exact text string to search for in the codebase.</param>
+    /// <returns>A JSON string containing an array of matches with file paths and line numbers.</returns>
     [McpTool("search_code")]
     [Description("Performs a text-based search across all code files for the specified text.")]
     public static string SearchCode(
         [Description("The exact text string to search for in the codebase")]
         string searchText) => 
         JsonSerializer.Serialize(CodeSearchService.SearchCode(searchText), DefaultJsonOptions);
 
+    /// <summary>
+    /// Performs a semantic similarity search across the codebase using AI.
+    /// </summary>
+    /// <param name="query">Natural language description of the code you're looking for.</param>
+    /// <param name="topK">Optional: Number of results to return (default: 5).</param>
+    /// <returns>A JSON string containing semantically relevant code snippets ranked by relevance.</returns>
+    /// <remarks>
+    /// This method uses AI embeddings to understand the semantic meaning of the query and find relevant code,
+    /// even if it doesn't contain the exact words used in the query.
+    /// </remarks>
     [McpTool("semantic_search")]
     [Description("Performs a semantic similarity search across the codebase using AI.")]
     public static async Task<string> SemanticSearchAsync(
@@ -39,4 +59,4 @@ public static async Task<string> SemanticSearchAsync(
             return JsonSerializer.Serialize(new { Error = ex.Message }, DefaultJsonOptions);
         }
     }
-} 
+}

tests/NetContextServer/NetContextServerTestCollection.cs

@@ -1,5 +1,3 @@
-using Xunit;
-
 namespace NetContextServer.Tests;
 
 [CollectionDefinition("NetContextServer Tests", DisableParallelization = true)]
@@ -8,4 +6,4 @@ public class NetContextServerTestCollection : ICollectionFixture<NetContextServe
     // This class has no code, and is never created. Its purpose is simply
     // to be the place to apply [CollectionDefinition] and all the
     // ICollectionFixture<> interfaces.
-} 
+}