Record Class McpGuideSearchResult

java.lang.Object

java.lang.Record

com.shaft.mcp.McpGuideSearchResult

Record Components:

schemaVersion - result schema version

query - searched query

sourceIndexUrl - official guide search index URL

matches - ranked official guide matches

guidanceRules - rules agents should apply when writing SHAFT code

warnings - safe warnings about missing or partial guide evidence

public record McpGuideSearchResult(String schemaVersion, String query, String sourceIndexUrl, List<McpGuideMatch> matches, List<String> guidanceRules, List<String> warnings)
extends Record

Official SHAFT user-guide search result for MCP agents.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_SCHEMA_VERSION	Current result schema version.

Constructor Summary

Constructors

Constructor	Description
McpGuideSearchResult(String schemaVersion, String query, String sourceIndexUrl, List<McpGuideMatch> matches, List<String> guidanceRules, List<String> warnings)	Creates an immutable guide search result.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	guidanceRules()	Returns the value of the guidanceRules record component.
final int	hashCode()	Returns a hash code value for this object.
List<McpGuideMatch>	matches()	Returns the value of the matches record component.
String	query()	Returns the value of the query record component.
String	schemaVersion()	Returns the value of the schemaVersion record component.
String	sourceIndexUrl()	Returns the value of the sourceIndexUrl record component.
final String	toString()	Returns a string representation of this record class.
List<String>	warnings()	Returns the value of the warnings record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

CURRENT_SCHEMA_VERSION

public static final String CURRENT_SCHEMA_VERSION

Current result schema version.

See Also:

• Constant Field Values

Constructor Details

McpGuideSearchResult

public McpGuideSearchResult(String schemaVersion,
 String query,
 String sourceIndexUrl,
 List<McpGuideMatch> matches,
 List<String> guidanceRules,
 List<String> warnings)

Creates an immutable guide search result.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

schemaVersion

public String schemaVersion()

Returns the value of the schemaVersion record component.

Returns:

the value of the schemaVersion record component

query

public String query()

Returns the value of the query record component.

Returns:

the value of the query record component

sourceIndexUrl

public String sourceIndexUrl()

Returns the value of the sourceIndexUrl record component.

Returns:

the value of the sourceIndexUrl record component

matches

public List<McpGuideMatch> matches()

Returns the value of the matches record component.

Returns:

the value of the matches record component

guidanceRules

public List<String> guidanceRules()

Returns the value of the guidanceRules record component.

Returns:

the value of the guidanceRules record component

warnings

public List<String> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component