docs: clarify HTML formatting support in comment tools (#11)#12
Merged
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies that comment operations support HTML formatting in Azure DevOps, addressing issue #11.
Problem
The
wit_add_work_item_commentandwit_update_work_item_commentMCP tools lacked clear documentation about HTML formatting support. Agents were unclear whether they could use HTML markup in comments.Solution
Updated tool descriptions to explicitly state that comments support HTML formatting (div, br, nbsp, span, lists, etc.), making it clear to agents that they can use HTML markup directly.
Note: Azure DevOps stores comments as rich text. For on-premises deployments without Markdown support, HTML formatting provides the formatting capabilities.
Changes
AddWorkItemCommentdocumentation to clarify HTML formatting supportUpdateWorkItemCommentdocumentation to clarify HTML formatting supportTesting
Related
Fixes #11