Share via

MCPListToolsTool Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.OpenAI
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
MCPListToolsTool.cs

A tool available on an MCP server.

public class MCPListToolsTool : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.MCPListToolsTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.MCPListToolsTool>
type MCPListToolsTool = class
    interface IUtf8JsonSerializable
    interface IJsonModel<MCPListToolsTool>
    interface IPersistableModel<MCPListToolsTool>
Public Class MCPListToolsTool
Implements IJsonModel(Of MCPListToolsTool), IPersistableModel(Of MCPListToolsTool), IUtf8JsonSerializable
Inheritance
Object
MCPListToolsTool
Implements
IUtf8JsonSerializable IJsonModel<MCPListToolsTool> IPersistableModel<MCPListToolsTool> IPersistableModel<T>

Constructors

Name Description
MCPListToolsTool()

Initializes a new instance of MCPListToolsTool for deserialization.
MCPListToolsTool(String, BinaryData)

Initializes a new instance of MCPListToolsTool.
MCPListToolsTool(String, String, BinaryData, BinaryData, IDictionary<String,BinaryData>)

Initializes a new instance of MCPListToolsTool.

Properties

Name Description
Annotations

Additional annotations about the tool.

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).

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" }.
Description

The description of the tool.
InputSchema

The JSON schema describing the tool's input.

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).

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" }.
Name

The name of the tool.

Methods

Name Description
DeserializeMCPListToolsTool(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<MCPListToolsTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<MCPListToolsTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<MCPListToolsTool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<MCPListToolsTool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<MCPListToolsTool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to