Class GuideService

java.lang.Object

com.shaft.mcp.GuideService

@Service
public class GuideService
extends Object

Searches the live official SHAFT user guide for MCP agents before they write SHAFT code.

Constructor Summary

Constructors

Constructor	Description
GuideService()	Creates the default live guide search service.

Method Summary

Modifier and Type	Method	Description
McpGuideSearchResult	search(String query, int maxResults)	Searches the official SHAFT user guide and returns cited guidance, excerpts, and code examples.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GuideService

public GuideService()

Creates the default live guide search service.

Method Details

search

@Tool(name="shaft_guide_search",
      description="searches the live official SHAFT user guide before writing SHAFT tests, page objects, locators, API, GUI, CLI, mobile, troubleshooting, or best-practice code")
public McpGuideSearchResult search(String query,
 int maxResults)

Searches the official SHAFT user guide and returns cited guidance, excerpts, and code examples.

Parameters:

query - topic to search for, such as page objects, locators, API, GUI, CLI, properties, or failures

maxResults - maximum matches to return; values are clamped to 1 through 5

Returns:

official guide search result