@frontmcp/plugins 0.4.0 → 0.5.0

package/src/codecall/tools/search.tool.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// file: libs/plugins/src/codecall/tools/search.tool.ts
+const sdk_1 = require("@frontmcp/sdk");
+const search_schema_1 = require("./search.schema");
+const services_1 = require("../services");
+let SearchTool = class SearchTool extends sdk_1.ToolContext {
+    async execute(input) {
+        const { queries, appIds, excludeToolNames = [], topK = 5, minRelevanceScore = 0.3 } = input;
+        const searchService = this.get(services_1.ToolSearchService);
+        const warnings = [];
+        // Check for excluded tools that don't exist in the index
+        const nonExistentExcludedTools = excludeToolNames.filter((toolName) => !searchService.hasTool(toolName));
+        if (nonExistentExcludedTools.length > 0) {
+            warnings.push({
+                type: 'excluded_tool_not_found',
+                message: `Excluded tools not found: ${nonExistentExcludedTools.join(', ')}`,
+                affectedTools: nonExistentExcludedTools,
+            });
+        }
+        // Track tools across all queries for deduplication
+        const toolMap = new Map();
+        let lowRelevanceCount = 0;
+        // Search for each query and merge results
+        for (const query of queries) {
+            const searchResults = await searchService.search(query, {
+                topK,
+                appIds,
+                excludeToolNames,
+            });
+            for (const result of searchResults) {
+                // Filter by minRelevanceScore
+                if (result.relevanceScore < minRelevanceScore) {
+                    lowRelevanceCount++;
+                    continue;
+                }
+                const existing = toolMap.get(result.toolName);
+                if (existing) {
+                    // Tool already found - add query to matchedQueries, keep highest score
+                    existing.matchedQueries.push(query);
+                    existing.relevanceScore = Math.max(existing.relevanceScore, result.relevanceScore);
+                }
+                else {
+                    // New tool
+                    toolMap.set(result.toolName, {
+                        name: result.toolName,
+                        appId: result.appId,
+                        description: result.description,
+                        relevanceScore: result.relevanceScore,
+                        matchedQueries: [query],
+                    });
+                }
+            }
+        }
+        // Convert to output format, sorted by relevance
+        const tools = Array.from(toolMap.values())
+            .sort((a, b) => b.relevanceScore - a.relevanceScore)
+            .map((tool) => ({
+            name: tool.name,
+            appId: tool.appId,
+            description: tool.description,
+            relevanceScore: tool.relevanceScore,
+            matchedQueries: tool.matchedQueries,
+        }));
+        // Add warning if no results found
+        if (tools.length === 0) {
+            warnings.push({
+                type: 'no_results',
+                message: `No tools found for queries: ${queries.join(', ')}${appIds?.length ? ` in apps: ${appIds.join(', ')}` : ''}`,
+            });
+        }
+        // Add warning if results were filtered due to low relevance
+        if (lowRelevanceCount > 0 && tools.length > 0) {
+            warnings.push({
+                type: 'low_relevance',
+                message: `${lowRelevanceCount} result(s) filtered due to relevance below ${minRelevanceScore}`,
+            });
+        }
+        return {
+            tools,
+            warnings,
+            totalAvailableTools: searchService.getTotalCount(),
+        };
+    }
+};
+SearchTool = tslib_1.__decorate([
+    (0, sdk_1.Tool)({
+        name: 'codecall:search',
+        cache: {
+            ttl: 60, // 1 minute
+            slideWindow: false,
+        },
+        codecall: {
+            enabledInCodeCall: false,
+            visibleInListTools: true,
+        },
+        description: search_schema_1.searchToolDescription,
+        inputSchema: search_schema_1.searchToolInputSchema,
+        outputSchema: search_schema_1.searchToolOutputSchema,
+        annotations: {
+            readOnlyHint: true,
+            openWorldHint: true,
+        },
+    })
+], SearchTool);
+exports.default = SearchTool;
+//# sourceMappingURL=search.tool.js.map

package/src/codecall/tools/search.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.tool.js","sourceRoot":"","sources":["../../../../src/codecall/tools/search.tool.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,uCAAkD;AAClD,mDAMyB;AACzB,0CAAgD;AA6BjC,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,iBAAW;IACjD,KAAK,CAAC,OAAO,CAAC,KAAsB;QAClC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC,EAAE,iBAAiB,GAAG,GAAG,EAAE,GAAG,KAAK,CAAC;QAE5F,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,4BAAiB,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAiC,EAAE,CAAC;QAElD,yDAAyD;QACzD,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjH,IAAI,wBAAwB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,yBAAyB;gBAC/B,OAAO,EAAE,6BAA6B,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC3E,aAAa,EAAE,wBAAwB;aACxC,CAAC,CAAC;QACL,CAAC;QAED,mDAAmD;QACnD,MAAM,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAC;QAC7C,IAAI,iBAAiB,GAAG,CAAC,CAAC;QAE1B,0CAA0C;QAC1C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE;gBACtD,IAAI;gBACJ,MAAM;gBACN,gBAAgB;aACjB,CAAC,CAAC;YAEH,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;gBACnC,8BAA8B;gBAC9B,IAAI,MAAM,CAAC,cAAc,GAAG,iBAAiB,EAAE,CAAC;oBAC9C,iBAAiB,EAAE,CAAC;oBACpB,SAAS;gBACX,CAAC;gBAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAC9C,IAAI,QAAQ,EAAE,CAAC;oBACb,uEAAuE;oBACvE,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACpC,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;gBACrF,CAAC;qBAAM,CAAC;oBACN,WAAW;oBACX,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE;wBAC3B,IAAI,EAAE,MAAM,CAAC,QAAQ;wBACrB,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,cAAc,EAAE,MAAM,CAAC,cAAc;wBACrC,cAAc,EAAE,CAAC,KAAK,CAAC;qBACxB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,gDAAgD;QAChD,MAAM,KAAK,GAA8B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;aAClE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,cAAc,CAAC;aACnD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACd,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC,CAAC,CAAC;QAEN,kCAAkC;QAClC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,+BAA+B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GACxD,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EACtD,EAAE;aACH,CAAC,CAAC;QACL,CAAC;QAED,4DAA4D;QAC5D,IAAI,iBAAiB,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,GAAG,iBAAiB,8CAA8C,iBAAiB,EAAE;aAC/F,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,KAAK;YACL,QAAQ;YACR,mBAAmB,EAAE,aAAa,CAAC,aAAa,EAAE;SACnD,CAAC;IACJ,CAAC;CACF,CAAA;AA1FoB,UAAU;IAlB9B,IAAA,UAAI,EAAC;QACJ,IAAI,EAAE,iBAAiB;QACvB,KAAK,EAAE;YACL,GAAG,EAAE,EAAE,EAAE,WAAW;YACpB,WAAW,EAAE,KAAK;SACnB;QACD,QAAQ,EAAE;YACR,iBAAiB,EAAE,KAAK;YACxB,kBAAkB,EAAE,IAAI;SACzB;QACD,WAAW,EAAE,qCAAqB;QAClC,WAAW,EAAE,qCAAqB;QAClC,YAAY,EAAE,sCAAsB;QACpC,WAAW,EAAE;YACX,YAAY,EAAE,IAAI;YAClB,aAAa,EAAE,IAAI;SACpB;KACF,CAAC;GACmB,UAAU,CA0F9B;kBA1FoB,UAAU","sourcesContent":["// file: libs/plugins/src/codecall/tools/search.tool.ts\nimport { Tool, ToolContext } from '@frontmcp/sdk';\nimport {\n  SearchToolInput,\n  searchToolInputSchema,\n  SearchToolOutput,\n  searchToolOutputSchema,\n  searchToolDescription,\n} from './search.schema';\nimport { ToolSearchService } from '../services';\n\n/** Internal type for tracking tool matches across queries */\ninterface ToolMatch {\n  name: string;\n  appId: string | undefined;\n  description: string;\n  relevanceScore: number;\n  matchedQueries: string[];\n}\n\n@Tool({\n  name: 'codecall:search',\n  cache: {\n    ttl: 60, // 1 minute\n    slideWindow: false,\n  },\n  codecall: {\n    enabledInCodeCall: false,\n    visibleInListTools: true,\n  },\n  description: searchToolDescription,\n  inputSchema: searchToolInputSchema,\n  outputSchema: searchToolOutputSchema,\n  annotations: {\n    readOnlyHint: true,\n    openWorldHint: true,\n  },\n})\nexport default class SearchTool extends ToolContext {\n  async execute(input: SearchToolInput): Promise<SearchToolOutput> {\n    const { queries, appIds, excludeToolNames = [], topK = 5, minRelevanceScore = 0.3 } = input;\n\n    const searchService = this.get(ToolSearchService);\n    const warnings: SearchToolOutput['warnings'] = [];\n\n    // Check for excluded tools that don't exist in the index\n    const nonExistentExcludedTools = excludeToolNames.filter((toolName: string) => !searchService.hasTool(toolName));\n\n    if (nonExistentExcludedTools.length > 0) {\n      warnings.push({\n        type: 'excluded_tool_not_found',\n        message: `Excluded tools not found: ${nonExistentExcludedTools.join(', ')}`,\n        affectedTools: nonExistentExcludedTools,\n      });\n    }\n\n    // Track tools across all queries for deduplication\n    const toolMap = new Map<string, ToolMatch>();\n    let lowRelevanceCount = 0;\n\n    // Search for each query and merge results\n    for (const query of queries) {\n      const searchResults = await searchService.search(query, {\n        topK,\n        appIds,\n        excludeToolNames,\n      });\n\n      for (const result of searchResults) {\n        // Filter by minRelevanceScore\n        if (result.relevanceScore < minRelevanceScore) {\n          lowRelevanceCount++;\n          continue;\n        }\n\n        const existing = toolMap.get(result.toolName);\n        if (existing) {\n          // Tool already found - add query to matchedQueries, keep highest score\n          existing.matchedQueries.push(query);\n          existing.relevanceScore = Math.max(existing.relevanceScore, result.relevanceScore);\n        } else {\n          // New tool\n          toolMap.set(result.toolName, {\n            name: result.toolName,\n            appId: result.appId,\n            description: result.description,\n            relevanceScore: result.relevanceScore,\n            matchedQueries: [query],\n          });\n        }\n      }\n    }\n\n    // Convert to output format, sorted by relevance\n    const tools: SearchToolOutput['tools'] = Array.from(toolMap.values())\n      .sort((a, b) => b.relevanceScore - a.relevanceScore)\n      .map((tool) => ({\n        name: tool.name,\n        appId: tool.appId,\n        description: tool.description,\n        relevanceScore: tool.relevanceScore,\n        matchedQueries: tool.matchedQueries,\n      }));\n\n    // Add warning if no results found\n    if (tools.length === 0) {\n      warnings.push({\n        type: 'no_results',\n        message: `No tools found for queries: ${queries.join(', ')}${\n          appIds?.length ? ` in apps: ${appIds.join(', ')}` : ''\n        }`,\n      });\n    }\n\n    // Add warning if results were filtered due to low relevance\n    if (lowRelevanceCount > 0 && tools.length > 0) {\n      warnings.push({\n        type: 'low_relevance',\n        message: `${lowRelevanceCount} result(s) filtered due to relevance below ${minRelevanceScore}`,\n      });\n    }\n\n    return {\n      tools,\n      warnings,\n      totalAvailableTools: searchService.getTotalCount(),\n    };\n  }\n}\n"]}

package/src/codecall/utils/describe.utils.d.ts

@@ -0,0 +1,86 @@
+import type { JSONSchema } from 'zod/v4/core';
+/** JSON Schema type from Zod v4 */
+type JsonSchema = JSONSchema.JSONSchema;
+/**
+ * Tool example for describe output
+ */
+export interface ToolUsageExample {
+    description: string;
+    code: string;
+}
+/**
+ * Detected intent of a tool based on its name and description.
+ */
+export type ToolIntent = 'create' | 'list' | 'get' | 'update' | 'delete' | 'search' | 'action' | 'unknown';
+/**
+ * Detect the intent of a tool from its name.
+ * Extracts the action verb from tool names like "users:create" or "orders:list".
+ */
+export declare function detectToolIntent(toolName: string, description?: string): ToolIntent;
+/**
+ * Generate a TypeScript-like function signature from a JSON Schema.
+ *
+ * @example
+ * Input: { type: 'object', properties: { id: { type: 'string' }, limit: { type: 'number' } }, required: ['id'] }
+ * Output: "(id: string, limit?: number) => unknown"
+ */
+export declare function jsonSchemaToSignature(toolName: string, inputSchema?: JsonSchema, outputSchema?: JsonSchema): string;
+/**
+ * Generate a natural language summary of a schema.
+ */
+export declare function jsonSchemaToNaturalLanguage(schema: JsonSchema | undefined | null, direction: 'input' | 'output'): string;
+/**
+ * Generate a basic usage example for a tool.
+ */
+export declare function generateBasicExample(toolName: string, inputSchema?: JsonSchema): ToolUsageExample;
+/**
+ * Check if a schema has pagination parameters.
+ */
+export declare function hasPaginationParams(schema?: JsonSchema): boolean;
+/**
+ * Check if a schema has filter-like parameters.
+ */
+export declare function hasFilterParams(schema?: JsonSchema): boolean;
+/**
+ * Get filter-like property names from a schema.
+ */
+export declare function getFilterProperties(schema?: JsonSchema): string[];
+/**
+ * Generate a pagination example for a tool.
+ */
+export declare function generatePaginationExample(toolName: string): ToolUsageExample;
+/**
+ * Generate a filter example for a tool.
+ */
+export declare function generateFilterExample(toolName: string, filterProp: string): ToolUsageExample;
+/**
+ * Generate a create example for a tool.
+ * Shows required parameters with contextual sample values.
+ */
+export declare function generateCreateExample(toolName: string, inputSchema?: JsonSchema): ToolUsageExample;
+/**
+ * Generate a get (retrieve single item) example for a tool.
+ */
+export declare function generateGetExample(toolName: string, inputSchema?: JsonSchema): ToolUsageExample;
+/**
+ * Generate a list example for a tool.
+ */
+export declare function generateListExample(toolName: string, inputSchema?: JsonSchema): ToolUsageExample;
+/**
+ * Generate an update example for a tool.
+ */
+export declare function generateUpdateExample(toolName: string, inputSchema?: JsonSchema): ToolUsageExample;
+/**
+ * Generate a delete example for a tool.
+ */
+export declare function generateDeleteExample(toolName: string, inputSchema?: JsonSchema): ToolUsageExample;
+/**
+ * Generate a search example for a tool.
+ */
+export declare function generateSearchExample(toolName: string, inputSchema?: JsonSchema): ToolUsageExample;
+/**
+ * Smart example generator that uses intent detection.
+ * This is the main entry point for generating examples.
+ */
+export declare function generateSmartExample(toolName: string, inputSchema?: JsonSchema, description?: string): ToolUsageExample;
+export {};