RequiredMcpToolCall Class

Definition

Namespace:: Azure.AI.Agents.Persistent

Assembly:: Azure.AI.Agents.Persistent.dll

Package:: Azure.AI.Agents.Persistent v1.2.0-beta.1

Source:: RequiredMcpToolCall.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A representation of a requested call to a MCP tool, needed by the model to continue evaluation of a run.

public class RequiredMcpToolCall : Azure.AI.Agents.Persistent.RequiredToolCall, System.ClientModel.Primitives.IJsonModel<Azure.AI.Agents.Persistent.RequiredMcpToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Agents.Persistent.RequiredMcpToolCall>

type RequiredMcpToolCall = class
    inherit RequiredToolCall
    interface IJsonModel<RequiredMcpToolCall>
    interface IPersistableModel<RequiredMcpToolCall>

Public Class RequiredMcpToolCall
Inherits RequiredToolCall
Implements IJsonModel(Of RequiredMcpToolCall), IPersistableModel(Of RequiredMcpToolCall)

Inheritance: Object

RequiredAction

RequiredToolCall
RequiredMcpToolCall

Implements: IJsonModel<RequiredMcpToolCall> IPersistableModel<RequiredMcpToolCall> IPersistableModel<T>

Properties

Arguments	The arguments to use when invoking the mcp tool, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation.
Id	The ID of the tool call. This ID must be referenced when submitting tool outputs. (Inherited from RequiredToolCall)
Name	The name of the function used on the MCP server.
ServerLabel	The label of the MCP server.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<RequiredAction>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from RequiredAction)
IJsonModel<RequiredAction>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from RequiredAction)
IJsonModel<RequiredMcpToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<RequiredMcpToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<RequiredToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from RequiredToolCall)
IJsonModel<RequiredToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from RequiredToolCall)
IPersistableModel<RequiredAction>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from RequiredAction)
IPersistableModel<RequiredAction>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from RequiredAction)
IPersistableModel<RequiredAction>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from RequiredAction)
IPersistableModel<RequiredMcpToolCall>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<RequiredMcpToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<RequiredMcpToolCall>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<RequiredToolCall>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from RequiredToolCall)
IPersistableModel<RequiredToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from RequiredToolCall)
IPersistableModel<RequiredToolCall>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from RequiredToolCall)

Applies to