KnowledgeBaseMcpServerReference Class

Package:
com.azure.search.documents.knowledgebases.models
Maven Artifact:
com.azure:azure-search-documents:12.1.0-beta.1

public final class KnowledgeBaseMcpServerReference
extends KnowledgeBaseReference

Represents an MCP server document reference.

Method Summary

Modifier and Type Method and Description
static KnowledgeBaseMcpServerReference fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseMcpServerReference from the JsonReader.
String getTitle()

Get the title property: The title of the MCP server tool result.
String getToolName()

Get the toolName property: The name of the MCP server tool that produced the reference.
KnowledgeBaseReferenceType getType()

Get the type property: The type of the reference.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from KnowledgeBaseReference

fromJson getActivitySource getId getRerankerScore getSourceData getType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static KnowledgeBaseMcpServerReference fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseMcpServerReference from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KnowledgeBaseMcpServerReference if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getTitle

public String getTitle()

Get the title property: The title of the MCP server tool result.

Returns:

the title value.

getToolName

public String getToolName()

Get the toolName property: The name of the MCP server tool that produced the reference.

Returns:

the toolName value.

getType

public KnowledgeBaseReferenceType getType()

Get the type property: The type of the reference.

Overrides:

KnowledgeBaseMcpServerReference.getType()

Returns:

the type value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

KnowledgeBaseMcpServerReference.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to