McpUiCallToolResult Class

The result of a widget's tools/call request, returned by the bot in response to an htmlwidget/calltool invoke activity.

Diagnostic: ExperimentalTeamsHtmlWidget

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

McpUiCallToolResult(*, content: list[typing.Annotated[typing.Union[microsoft_teams.api.models.html_widget.call_tool_result.McpUiTextContent, microsoft_teams.api.models.html_widget.call_tool_result.McpUiImageContent, microsoft_teams.api.models.html_widget.call_tool_result.McpUiAudioContent, microsoft_teams.api.models.html_widget.call_tool_result.McpUiResourceContent], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] | None = None, structuredContent: Any | None = None, isError: bool | None = None, **extra_data: Any)

Keyword-Only Parameters

Name Description
content
Default value: None
structuredContent
Default value: None
isError
Default value: None

Attributes

content

An array of content items to return to the widget.

content: list[typing.Annotated[typing.Union[microsoft_teams.api.models.html_widget.call_tool_result.McpUiTextContent, microsoft_teams.api.models.html_widget.call_tool_result.McpUiImageContent, microsoft_teams.api.models.html_widget.call_tool_result.McpUiAudioContent, microsoft_teams.api.models.html_widget.call_tool_result.McpUiResourceContent], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] | None

is_error

Whether the tool call resulted in an error.

is_error: bool | None

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_config: ClassVar[ConfigDict] = {'alias_generator': AliasGenerator(alias=None, validation_alias=<staticmethod(<function CustomBaseModel.validation_alias_generator>)>, serialization_alias=<staticmethod(<function CustomBaseModel.serialization_alias_generator>)>), 'arbitrary_types_allowed': True, 'extra': 'allow', 'populate_by_name': True, 'serialize_by_alias': True, 'validate_by_alias': True, 'validate_by_name': True}

structured_content

Structured data that the widget can render from.

structured_content: Any | None