Share via


MCPToolDefinition Class

Definition

The input definition information for a MCP tool which defines a MCP server endpoint.

public class MCPToolDefinition : Azure.AI.Agents.Persistent.ToolDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.Agents.Persistent.MCPToolDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Agents.Persistent.MCPToolDefinition>
type MCPToolDefinition = class
    inherit ToolDefinition
    interface IJsonModel<MCPToolDefinition>
    interface IPersistableModel<MCPToolDefinition>
Public Class MCPToolDefinition
Inherits ToolDefinition
Implements IJsonModel(Of MCPToolDefinition), IPersistableModel(Of MCPToolDefinition)
Inheritance
MCPToolDefinition
Implements

Constructors

MCPToolDefinition(String, String)

Initializes a new instance of MCPToolDefinition.

Properties

AllowedTools

List of allowed tools for MCP server.

ServerLabel

The label for the MCP server.

ServerUrl

The endpoint for the MCP server.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<MCPToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<MCPToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<ToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ToolDefinition)
IJsonModel<ToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ToolDefinition)
IPersistableModel<MCPToolDefinition>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MCPToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<MCPToolDefinition>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<ToolDefinition>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ToolDefinition)
IPersistableModel<ToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ToolDefinition)
IPersistableModel<ToolDefinition>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ToolDefinition)

Applies to