feat: HTML widget support (MCP Apps UI)#626
Draft
corinagum wants to merge 9 commits into
Draft
Conversation
Add types for the HTML widget contract: - IHtmlWidgetPayload, IHtmlWidgetSecurityPolicy, IHtmlWidgetPermissions - ICallToolRequest, IMcpUiCallToolResult - IHtmlWidgetCallToolInvokeActivity (htmlwidget/calltool invoke) - Add 'extendedmarkdown' to TextFormat union - Add htmlwidget/calltool to InvokeResponseBody map Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Add 'htmlwidget/calltool' -> 'widget.callTool' invoke alias - Add WidgetCallToolRoutes type for typed handler registration - Add buildHtmlWidgetMarkdown() and buildHtmlWidgetMessage() helpers - Add unit tests (14 cases including edge cases) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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
Adds HTML widget support to the Teams TypeScript SDK, enabling bots to send rich interactive MCP Apps UI widgets in Teams messages.
What's included
API types (
@microsoft/teams.api)IHtmlWidgetPayload,IHtmlWidgetSecurityPolicy,IHtmlWidgetPermissionsIMcpUiCallToolResult,IHtmlWidgetCallToolResponse(wire-format wrapper)IHtmlWidgetCallToolInvokeActivityand invoke response mappingextendedmarkdownadded toTextFormatApp helpers (
@microsoft/teams.apps)buildHtmlWidgetMarkdown- wraps payload in```html-widgetcode fencebuildHtmlWidgetMessage- builds a ready-to-send message activityinjectWidgetProtocol- optional convenience helper that injects the MCP Apps protocol (ui/initialize handshake, size reporting, notification hooks)validateHtmlWidgetPayload- runtime validation (name, html, domain)widget.callToolinvoke routeExample bot (
examples/html-widgets/)widget.callToolhandler with multi-tool dispatchIntegration tests
Preview markers
@experimentalwithDiagnostic: ExperimentalTeamsHtmlWidgetDesign decisions
injectWidgetProtocolis called internally by the builders, but widgets that implement the MCP Apps protocol themselves are returned unchanged (detected by presence ofui/initialize)Related
Status
Draft - pending: