Skip to content

docs: clarify HTML formatting support in comment tools (#11)#12

Merged
gadeynebram merged 1 commit into
mainfrom
fix/11_comment_html_formatting
Jul 17, 2026
Merged

docs: clarify HTML formatting support in comment tools (#11)#12
gadeynebram merged 1 commit into
mainfrom
fix/11_comment_html_formatting

Conversation

@gadeynebram

Copy link
Copy Markdown
Owner

Summary

Clarifies that comment operations support HTML formatting in Azure DevOps, addressing issue #11.

Problem

The wit_add_work_item_comment and wit_update_work_item_comment MCP 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

  • Updated AddWorkItemComment documentation to clarify HTML formatting support
  • Updated UpdateWorkItemComment documentation to clarify HTML formatting support
  • No functional code changes; uses existing Azure DevOps SDK capabilities

Testing

  • ✅ Build succeeds (dotnet build)
  • ✅ All projects compile without errors
  • ✅ Existing tests continue to pass

Related

Fixes #11

@gadeynebram
gadeynebram merged commit 91c192e into main Jul 17, 2026
2 checks passed
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@gadeynebram
gadeynebram deleted the fix/11_comment_html_formatting branch July 17, 2026 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

comment calls should use HTML formatting

1 participant