OutputItemMcpToolCall Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.4
Source:
OutputItemMcpToolCall.cs

MCP tool call.

public class OutputItemMcpToolCall : Azure.AI.AgentServer.Responses.Models.OutputItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.OutputItemMcpToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.OutputItemMcpToolCall>
type OutputItemMcpToolCall = class
    inherit OutputItem
    interface IJsonModel<OutputItemMcpToolCall>
    interface IPersistableModel<OutputItemMcpToolCall>
Public Class OutputItemMcpToolCall
Inherits OutputItem
Implements IJsonModel(Of OutputItemMcpToolCall), IPersistableModel(Of OutputItemMcpToolCall)
Inheritance
Object
OutputItem
OutputItemMcpToolCall
Implements
IJsonModel<OutputItemMcpToolCall> IPersistableModel<OutputItemMcpToolCall> IPersistableModel<T>

Constructors

Name Description
OutputItemMcpToolCall(String, String, String, String)

Initializes a new instance of OutputItemMcpToolCall.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
ApprovalRequestId

Gets or sets the ApprovalRequestId.
Arguments

A JSON string of the arguments passed to the tool.
CreatedBy

The information about the creator of the item

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

(Inherited from OutputItem)
Error

Gets the Error.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Id

The unique ID of the tool call.
Name

The name of the tool that was run.
Output

Gets or sets the Output.
ResponseId

The response on which the item is created.

(Inherited from OutputItem)
ServerLabel

The label of the MCP server running the tool.
Status

The status of the tool call. One of in_progress, completed, incomplete, calling, or failed.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<OutputItem>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItemMcpToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItemMcpToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<OutputItem>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.Write(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItemMcpToolCall>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItemMcpToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItemMcpToolCall>.Write(ModelReaderWriterOptions)

Extension Methods

Name Description
GetId(OutputItem)

Gets the Id property from an OutputItem. Uses direct type checks for known subclasses; falls back to JSON serialization for unrecognized types.

Applies to