ItemFieldMcpToolCall Class

Definition

MCP tool call.

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

Properties

Name Description
ApprovalRequestId

Gets the ApprovalRequestId.

Arguments

A JSON string of the arguments passed to the tool.

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 the Output.

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<ItemField>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ItemField)
IJsonModel<ItemField>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ItemField)
IJsonModel<ItemFieldMcpToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ItemFieldMcpToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ItemField>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ItemField)
IPersistableModel<ItemField>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ItemField)
IPersistableModel<ItemField>.Write(ModelReaderWriterOptions) (Inherited from ItemField)
IPersistableModel<ItemFieldMcpToolCall>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ItemFieldMcpToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ItemFieldMcpToolCall>.Write(ModelReaderWriterOptions)

Applies to