From 0cd6053e5ab49cf620de16f271b2ac80d694b394 Mon Sep 17 00:00:00 2001
From: Bram Gadeyne <bram.gadeyne@uzgent.be>
Date: Fri, 17 Jul 2026 10:32:45 +0200
Subject: [PATCH] docs: clarify HTML formatting support in comment tools (#11)

---
 .../src/G5e.AzureDevOpsServerMCP.Tools/WorkItemTools.cs   | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/dotnet/src/G5e.AzureDevOpsServerMCP.Tools/WorkItemTools.cs b/dotnet/src/G5e.AzureDevOpsServerMCP.Tools/WorkItemTools.cs
index e51170b6..c668a09a 100644
--- a/dotnet/src/G5e.AzureDevOpsServerMCP.Tools/WorkItemTools.cs
+++ b/dotnet/src/G5e.AzureDevOpsServerMCP.Tools/WorkItemTools.cs
@@ -69,10 +69,10 @@ public async Task<string> GetWorkItemContext(string collection, string project,
     /// <param name="collection">The Azure DevOps collection name</param>
     /// <param name="project">The Azure DevOps project name or ID</param>
     /// <param name="workItemId">The numeric work item ID</param>
-    /// <param name="comment">The comment content to add. Azure DevOps stores comments as rich text (typically HTML), so formatting markup such as &lt;div&gt;, &lt;br&gt;, &amp;nbsp;, &lt;span&gt;, lists, and related HTML elements may be present.</param>
+    /// <param name="comment">The comment content to add. Azure DevOps stores comments as rich text and supports both plain text and basic HTML formatting (div, br, nbsp, span, lists, etc.).</param>
     /// <returns>JSON object with the created comment ID and URL</returns>
     [McpServerTool(Name = "wit_add_work_item_comment")]
-    [Description("Adds a comment to a work item in Azure DevOps. Comments are stored as rich text (typically HTML), and may include markup such as div, br, nbsp, spans, lists, and other formatting elements.")]
+    [Description("Adds a comment to a work item in Azure DevOps. Comments can include HTML formatting such as div, br, nbsp, spans, lists, and other basic HTML elements.")]
     public async Task<string> AddWorkItemComment(string collection, string project, int workItemId, string comment)
     {
         try
@@ -99,10 +99,10 @@ public async Task<string> AddWorkItemComment(string collection, string project,
     /// <param name="project">The Azure DevOps project name or ID</param>
     /// <param name="workItemId">The numeric work item ID</param>
     /// <param name="commentId">The ID of the comment to update</param>
-    /// <param name="text">The updated comment content. Azure DevOps stores comments as rich text (typically HTML), so formatting markup such as &lt;div&gt;, &lt;br&gt;, &amp;nbsp;, &lt;span&gt;, lists, and related HTML elements may be present.</param>
+    /// <param name="text">The updated comment content. Azure DevOps stores comments as rich text and supports both plain text and basic HTML formatting (div, br, nbsp, span, lists, etc.).</param>
     /// <returns>JSON object with the updated comment details</returns>
     [McpServerTool(Name = "wit_update_work_item_comment")]
-    [Description("Updates an existing comment on a work item in Azure DevOps. Comments are stored as rich text (typically HTML), and may include markup such as div, br, nbsp, spans, lists, and other formatting elements.")]
+    [Description("Updates an existing comment on a work item in Azure DevOps. Comments can include HTML formatting such as div, br, nbsp, spans, lists, and other basic HTML elements.")]
     public async Task<string> UpdateWorkItemComment(string collection, string project, int workItemId, int commentId, string text)
     {
         try