saasusDocsSearchTool
Search SaaSus Platform documentation to find relevant article URLs for your queries. Use this tool to locate documentation before fetching full content.
Instructions
Search SaaSus Platform documentation to find relevant article URLs. Use this tool first to find relevant articles, then use saasus-docs-get-content tool to fetch the full content of specific articles.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query to find relevant SaaSus Platform documentation |
Implementation Reference
- Defines the saasusDocsSearchTool including id, description, Zod input/output schemas, and execute handler that invokes the search logic.export const saasusDocsSearchTool = createTool({ id: "saasus-docs-search-urls", description: "Search SaaSus Platform documentation to find relevant article URLs. Use this tool first to find relevant articles, then use saasus-docs-get-content tool to fetch the full content of specific articles.", inputSchema: z.object({ query: z .string() .describe("Search query to find relevant SaaSus Platform documentation"), }), outputSchema: z.object({ query: z.string(), results: z.array( z.object({ score: z.number(), title: z.string(), url: z.string(), excerpt: z.string(), }) ), }), execute: async ({ context }) => { return await searchSaaSusDocs(context.query); }, });
- src/mastra/mcp/saasus-platform-docs-search-mcp.ts:7-15 (registration)Registers saasusDocsSearchTool in the tools object of the MCPServer instance.export const mcpServer = new MCPServer({ name: "SaaSus Platform Docs Search", version: packageJson.version, tools: { saasusDocsSearchTool, saasusDocsContentTool, saasusDocsSitemapTool, }, });
- Main helper function implementing the Lunr-based search logic, fetching index from remote, applying multiple search strategies, and formatting results.const searchSaaSusDocs = async ( query: string ): Promise<{ query: string; results: SearchResult[] }> => { if (!query) { throw new Error("Query is required"); } const response = await fetch(INDEX_URL); if (!response.ok) { throw new Error(`HTTP ${response.status}`); } const indexData = await response.json(); if (!Array.isArray(indexData)) { throw new Error("Index is not array (expected array)"); } const results = indexData.flatMap((indexItem: IndexItem) => { const index = lunr.Index.load(indexItem.index); const store = indexItem.documents; // Try multiple search strategies for better recall const searchStrategies = []; // Always try exact query first searchStrategies.push(query); // For single word queries, add wildcard variations const words = query.trim().split(/\s+/); if (words.length === 1) { searchStrategies.push(`${query}*`); // Prefix wildcard searchStrategies.push(`*${query}*`); // Contains wildcard // Only add character-split search for very short single words (1-3 characters) if (query.length <= 3) { searchStrategies.push(query.split("").join("* ") + "*"); } } else { // For multi-word queries, try different combinations searchStrategies.push(words.map((word) => `${word}*`).join(" ")); // Each word with prefix wildcard searchStrategies.push(words.map((word) => `*${word}*`).join(" ")); // Each word with contains wildcard } const allResults = new Map<string, lunr.Index.Result>(); searchStrategies.forEach((searchQuery, strategyIndex) => { try { const strategyResults = index.search(searchQuery); strategyResults.forEach((result) => { const key = String(result.ref); if ( !allResults.has(key) || allResults.get(key)!.score < result.score ) { // Adjust score based on strategy (exact matches get higher scores) const adjustedScore = result.score * (1 - strategyIndex * 0.1); allResults.set(key, { ...result, score: adjustedScore }); } }); } catch (error) { // Log search errors for debugging but continue with other strategies console.warn(`Search strategy "${searchQuery}" failed:`, error); } }); return Array.from(allResults.values()).map((searchResult) => { const refString = String(searchResult.ref); const document = findDocument(store, refString); return formatResult(searchResult, document); }); }); // Sort by score (descending) and limit to 10 results const sortedResults = results.sort((a, b) => b.score - a.score).slice(0, 10); return { query, results: sortedResults }; };
- Helper functions to find document by ref and format search results into output structure.function findDocument(store: Document[], ref: string): Document { return store.find((doc) => doc.i === Number(ref)) || { i: 0 }; } function formatResult( searchResult: lunr.Index.Result, document: Document ): SearchResult { return { score: searchResult.score, title: document.s || document.t || "", url: `https://docs.saasus.io${document.u || ""}`, excerpt: String(document.t || document.s || "") .replace(/\s+/g, " ") .slice(0, 160), }; }