KnowledgeBaseMcpServerActivityArguments Class

Definition

Namespace:
Azure.Search.Documents.KnowledgeBases.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.1.0-beta.1
Source:
KnowledgeBaseMcpServerActivityArguments.cs

Represents the arguments the MCP server retrieval activity was run with.

public class KnowledgeBaseMcpServerActivityArguments : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMcpServerActivityArguments>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMcpServerActivityArguments>
type KnowledgeBaseMcpServerActivityArguments = class
    interface IJsonModel<KnowledgeBaseMcpServerActivityArguments>
    interface IPersistableModel<KnowledgeBaseMcpServerActivityArguments>
Public Class KnowledgeBaseMcpServerActivityArguments
Implements IJsonModel(Of KnowledgeBaseMcpServerActivityArguments), IPersistableModel(Of KnowledgeBaseMcpServerActivityArguments)
Inheritance
Object
KnowledgeBaseMcpServerActivityArguments
Implements
IJsonModel<KnowledgeBaseMcpServerActivityArguments> IPersistableModel<KnowledgeBaseMcpServerActivityArguments> IPersistableModel<T>

Properties

Name Description
ToolArguments

The arguments passed to the MCP server tool.

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

ToolName

The name of the MCP server tool used for the retrieval activity.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<KnowledgeBaseMcpServerActivityArguments>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<KnowledgeBaseMcpServerActivityArguments>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseMcpServerActivityArguments>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseMcpServerActivityArguments>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseMcpServerActivityArguments>.Write(ModelReaderWriterOptions)

Applies to