@mxf-dev/core 1.0.0

package/dist/protocols/mcp/McpToolCallParser.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * Structured tool call format
+ */
+export interface ParsedToolCall {
+    tool: string;
+    parameters: Record<string, any>;
+    format?: 'json' | 'xml' | 'function' | 'structured';
+    raw?: string;
+}
+/**
+ * Tool call parsing result
+ */
+export interface ToolCallParseResult {
+    success: boolean;
+    calls?: ParsedToolCall[];
+    errors?: string[];
+    suggestions?: string[];
+}
+/**
+ * Parse tool calls from content
+ * @param content - Content potentially containing tool calls
+ * @returns Parsed tool calls with success status
+ */
+export declare function parseToolCalls(content: string): ToolCallParseResult;
+/**
+ * Format tool call for display
+ * @param call - Parsed tool call
+ * @returns Formatted string representation
+ */
+export declare function formatToolCall(call: ParsedToolCall): string;
+/**
+ * Validate parsed tool call against known tools
+ * @param call - Parsed tool call
+ * @param knownTools - Set of known tool names
+ * @returns Validation result with suggestions
+ */
+export declare function validateParsedToolCall(call: ParsedToolCall, knownTools: Set<string>): {
+    valid: boolean;
+    error?: string;
+    suggestion?: string;
+};
+/**
+ * Generate tool call examples for a given tool
+ * @param toolName - Name of the tool
+ * @param schema - Tool input schema
+ * @returns Array of example formats
+ */
+export declare function generateToolCallExamples(toolName: string, schema: Record<string, any>): string[];
+//# sourceMappingURL=McpToolCallParser.d.ts.map

package/dist/protocols/mcp/McpToolCallParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpToolCallParser.d.ts","sourceRoot":"","sources":["../../../src/protocols/mcp/McpToolCallParser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAeH;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,UAAU,GAAG,YAAY,CAAC;IACpD,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AA6FD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,mBAAmB,CA6DnE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAClC,IAAI,EAAE,cAAc,EACpB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,GACxB;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAkBzD;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACpC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,MAAM,EAAE,CAqCV"}

package/dist/protocols/mcp/McpToolCallParser.js

@@ -0,0 +1,240 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * MCP Tool Call Parser
+ *
+ * Provides structured parsing for tool calls from various LLM providers.
+ * Handles different formats and provides clear error messages for malformed calls.
+ */
+import { Logger } from '../../utils/Logger.js';
+import { createStrictValidator } from '../../utils/validation.js';
+const logger = new Logger('info', 'McpToolCallParser', 'server');
+const validator = createStrictValidator('McpToolCallParser');
+/**
+ * Known tool call formats from various providers
+ */
+const TOOL_CALL_PATTERNS = {
+    // Anthropic-style XML format
+    xml: {
+        pattern: /<tool>(.*?)<\/tool>.*?<parameters>(.*?)<\/parameters>/gs,
+        parser: (match) => {
+            const toolName = match[1].trim();
+            let parameters = {};
+            try {
+                // Try to parse as JSON first
+                parameters = JSON.parse(match[2]);
+            }
+            catch {
+                // If not JSON, try to parse as key-value pairs
+                const paramString = match[2].trim();
+                if (paramString) {
+                    // Simple key="value" parser
+                    const kvPattern = /(\w+)="([^"]+)"/g;
+                    let kvMatch;
+                    while ((kvMatch = kvPattern.exec(paramString)) !== null) {
+                        parameters[kvMatch[1]] = kvMatch[2];
+                    }
+                }
+            }
+            return {
+                tool: toolName,
+                parameters,
+                format: 'xml',
+                raw: match[0]
+            };
+        }
+    },
+    // JSON-RPC style
+    jsonRpc: {
+        pattern: /\{"method":\s*"([^"]+)",\s*"params":\s*(\{[^}]+\})\}/g,
+        parser: (match) => {
+            return {
+                tool: match[1],
+                parameters: JSON.parse(match[2]),
+                format: 'json',
+                raw: match[0]
+            };
+        }
+    },
+    // Function call style
+    functionCall: {
+        pattern: /(\w+)\s*\((\{[^}]+\})\)/g,
+        parser: (match) => {
+            return {
+                tool: match[1],
+                parameters: JSON.parse(match[2]),
+                format: 'function',
+                raw: match[0]
+            };
+        }
+    },
+    // OpenAI function calling format
+    openAiFunction: {
+        pattern: /\{"name":\s*"([^"]+)",\s*"arguments":\s*"([^"]+)"\}/g,
+        parser: (match) => {
+            // OpenAI escapes the JSON in arguments
+            const unescapedArgs = match[2].replace(/\\"/g, '"');
+            return {
+                tool: match[1],
+                parameters: JSON.parse(unescapedArgs),
+                format: 'structured',
+                raw: match[0]
+            };
+        }
+    },
+    // Structured format with clear markers
+    structured: {
+        pattern: /TOOL:\s*(\w+)\s*PARAMETERS:\s*(\{[^}]+\})/g,
+        parser: (match) => {
+            return {
+                tool: match[1],
+                parameters: JSON.parse(match[2]),
+                format: 'structured',
+                raw: match[0]
+            };
+        }
+    }
+};
+/**
+ * Parse tool calls from content
+ * @param content - Content potentially containing tool calls
+ * @returns Parsed tool calls with success status
+ */
+export function parseToolCalls(content) {
+    const calls = [];
+    const errors = [];
+    const suggestions = [];
+    if (!content || typeof content !== 'string') {
+        return {
+            success: false,
+            errors: ['Content must be a non-empty string']
+        };
+    }
+    // Try each pattern
+    let foundAny = false;
+    for (const [formatName, format] of Object.entries(TOOL_CALL_PATTERNS)) {
+        const pattern = new RegExp(format.pattern);
+        let match;
+        while ((match = pattern.exec(content)) !== null) {
+            foundAny = true;
+            try {
+                const parsed = format.parser(match);
+                calls.push(parsed);
+            }
+            catch (error) {
+                const errorMsg = `Failed to parse ${formatName} tool call: ${error instanceof Error ? error.message : String(error)}`;
+                errors.push(errorMsg);
+                logger.error(errorMsg);
+            }
+        }
+    }
+    // If no structured format found, try to detect and suggest corrections
+    if (!foundAny) {
+        // Look for potential tool names
+        const toolNamePattern = /\b(filesystem_read|filesystem_write|memory_store|shell_exec|messaging_send|messaging_discover)\b/gi;
+        const potentialTools = content.match(toolNamePattern);
+        if (potentialTools && potentialTools.length > 0) {
+            suggestions.push('Detected potential tool names but no valid format. Use one of these formats:', '1. XML: <tool>tool_name</tool><parameters>{"key": "value"}</parameters>', '2. Function: tool_name({"key": "value"})', '3. Structured: TOOL: tool_name PARAMETERS: {"key": "value"}');
+            // Try to extract JSON-like content
+            const jsonPattern = /\{[^{}]*\}/g;
+            const jsonMatches = content.match(jsonPattern);
+            if (jsonMatches) {
+                suggestions.push(`Found potential parameters: ${jsonMatches[0]}`);
+            }
+        }
+    }
+    return {
+        success: calls.length > 0,
+        calls: calls.length > 0 ? calls : undefined,
+        errors: errors.length > 0 ? errors : undefined,
+        suggestions: suggestions.length > 0 ? suggestions : undefined
+    };
+}
+/**
+ * Format tool call for display
+ * @param call - Parsed tool call
+ * @returns Formatted string representation
+ */
+export function formatToolCall(call) {
+    return `${call.tool}(${JSON.stringify(call.parameters, null, 2)})`;
+}
+/**
+ * Validate parsed tool call against known tools
+ * @param call - Parsed tool call
+ * @param knownTools - Set of known tool names
+ * @returns Validation result with suggestions
+ */
+export function validateParsedToolCall(call, knownTools) {
+    if (!knownTools.has(call.tool)) {
+        // Find similar tool names
+        const similar = Array.from(knownTools).filter(tool => tool.toLowerCase().includes(call.tool.toLowerCase()) ||
+            call.tool.toLowerCase().includes(tool.toLowerCase()));
+        return {
+            valid: false,
+            error: `Unknown tool: ${call.tool}`,
+            suggestion: similar.length > 0
+                ? `Did you mean: ${similar.join(', ')}?`
+                : `Available tools: ${Array.from(knownTools).slice(0, 5).join(', ')}...`
+        };
+    }
+    return { valid: true };
+}
+/**
+ * Generate tool call examples for a given tool
+ * @param toolName - Name of the tool
+ * @param schema - Tool input schema
+ * @returns Array of example formats
+ */
+export function generateToolCallExamples(toolName, schema) {
+    // Create a simple example based on schema
+    const exampleParams = {};
+    if (schema.properties) {
+        for (const [key, prop] of Object.entries(schema.properties)) {
+            if (schema.required?.includes(key)) {
+                // Generate example value based on type
+                switch (prop.type) {
+                    case 'string':
+                        exampleParams[key] = prop.example || prop.default || 'example_value';
+                        break;
+                    case 'number':
+                    case 'integer':
+                        exampleParams[key] = prop.example || prop.default || 0;
+                        break;
+                    case 'boolean':
+                        exampleParams[key] = prop.example || prop.default || false;
+                        break;
+                    case 'array':
+                        exampleParams[key] = prop.example || [];
+                        break;
+                    case 'object':
+                        exampleParams[key] = prop.example || {};
+                        break;
+                }
+            }
+        }
+    }
+    const jsonParams = JSON.stringify(exampleParams, null, 2);
+    return [
+        `XML Format:\n<tool>${toolName}</tool>\n<parameters>\n${jsonParams}\n</parameters>`,
+        `Function Format:\n${toolName}(${JSON.stringify(exampleParams)})`,
+        `Structured Format:\nTOOL: ${toolName}\nPARAMETERS: ${JSON.stringify(exampleParams)}`
+    ];
+}
+//# sourceMappingURL=McpToolCallParser.js.map

package/dist/protocols/mcp/McpToolCallParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpToolCallParser.js","sourceRoot":"","sources":["../../../src/protocols/mcp/McpToolCallParser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;AACjE,MAAM,SAAS,GAAG,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;AAsB7D;;GAEG;AACH,MAAM,kBAAkB,GAAG;IACvB,6BAA6B;IAC7B,GAAG,EAAE;QACD,OAAO,EAAE,yDAAyD;QAClE,MAAM,EAAE,CAAC,KAAsB,EAAkB,EAAE;YAC/C,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACjC,IAAI,UAAU,GAAwB,EAAE,CAAC;YAEzC,IAAI,CAAC;gBACD,6BAA6B;gBAC7B,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,CAAC;YAAC,MAAM,CAAC;gBACL,+CAA+C;gBAC/C,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBACpC,IAAI,WAAW,EAAE,CAAC;oBACd,4BAA4B;oBAC5B,MAAM,SAAS,GAAG,kBAAkB,CAAC;oBACrC,IAAI,OAAO,CAAC;oBACZ,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;wBACtD,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;oBACxC,CAAC;gBACL,CAAC;YACL,CAAC;YAED,OAAO;gBACH,IAAI,EAAE,QAAQ;gBACd,UAAU;gBACV,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;aAChB,CAAC;QACN,CAAC;KACJ;IAED,iBAAiB;IACjB,OAAO,EAAE;QACL,OAAO,EAAE,uDAAuD;QAChE,MAAM,EAAE,CAAC,KAAsB,EAAkB,EAAE;YAC/C,OAAO;gBACH,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;aAChB,CAAC;QACN,CAAC;KACJ;IAED,sBAAsB;IACtB,YAAY,EAAE;QACV,OAAO,EAAE,0BAA0B;QACnC,MAAM,EAAE,CAAC,KAAsB,EAAkB,EAAE;YAC/C,OAAO;gBACH,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,MAAM,EAAE,UAAU;gBAClB,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;aAChB,CAAC;QACN,CAAC;KACJ;IAED,iCAAiC;IACjC,cAAc,EAAE;QACZ,OAAO,EAAE,sDAAsD;QAC/D,MAAM,EAAE,CAAC,KAAsB,EAAkB,EAAE;YAC/C,uCAAuC;YACvC,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACpD,OAAO;gBACH,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC;gBACrC,MAAM,EAAE,YAAY;gBACpB,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;aAChB,CAAC;QACN,CAAC;KACJ;IAED,uCAAuC;IACvC,UAAU,EAAE;QACR,OAAO,EAAE,4CAA4C;QACrD,MAAM,EAAE,CAAC,KAAsB,EAAkB,EAAE;YAC/C,OAAO;gBACH,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,MAAM,EAAE,YAAY;gBACpB,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;aAChB,CAAC;QACN,CAAC;KACJ;CACJ,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe;IAC1C,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO;YACH,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,CAAC,oCAAoC,CAAC;SACjD,CAAC;IACN,CAAC;IAED,mBAAmB;IACnB,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACpE,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,KAAK,CAAC;QAEV,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YAC9C,QAAQ,GAAG,IAAI,CAAC;YAChB,IAAI,CAAC;gBACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACpC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,QAAQ,GAAG,mBAAmB,UAAU,eAAe,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtH,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC;IACL,CAAC;IAED,uEAAuE;IACvE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,gCAAgC;QAChC,MAAM,eAAe,GAAG,oGAAoG,CAAC;QAC7H,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEtD,IAAI,cAAc,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,WAAW,CAAC,IAAI,CACZ,8EAA8E,EAC9E,yEAAyE,EACzE,0CAA0C,EAC1C,6DAA6D,CAChE,CAAC;YAEF,mCAAmC;YACnC,MAAM,WAAW,GAAG,aAAa,CAAC;YAClC,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAC/C,IAAI,WAAW,EAAE,CAAC;gBACd,WAAW,CAAC,IAAI,CAAC,+BAA+B,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACtE,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO;QACH,OAAO,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC;QACzB,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;QAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QAC9C,WAAW,EAAE,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;KAChE,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,IAAoB;IAC/C,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAClC,IAAoB,EACpB,UAAuB;IAEvB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,0BAA0B;QAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CACjD,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACpD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CACvD,CAAC;QAEF,OAAO;YACH,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,iBAAiB,IAAI,CAAC,IAAI,EAAE;YACnC,UAAU,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC;gBAC1B,CAAC,CAAC,iBAAiB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;gBACxC,CAAC,CAAC,oBAAoB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;SAC/E,CAAC;IACN,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACpC,QAAgB,EAChB,MAA2B;IAE3B,0CAA0C;IAC1C,MAAM,aAAa,GAAwB,EAAE,CAAC;IAE9C,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAiC,CAAC,EAAE,CAAC;YACjF,IAAI,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,uCAAuC;gBACvC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBAChB,KAAK,QAAQ;wBACT,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,eAAe,CAAC;wBACrE,MAAM;oBACV,KAAK,QAAQ,CAAC;oBACd,KAAK,SAAS;wBACV,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;wBACvD,MAAM;oBACV,KAAK,SAAS;wBACV,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC;wBAC3D,MAAM;oBACV,KAAK,OAAO;wBACR,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;wBACxC,MAAM;oBACV,KAAK,QAAQ;wBACT,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;wBACxC,MAAM;gBACd,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAE1D,OAAO;QACH,sBAAsB,QAAQ,0BAA0B,UAAU,iBAAiB;QACnF,qBAAqB,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG;QACjE,6BAA6B,QAAQ,iBAAiB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE;KACxF,CAAC;AACN,CAAC"}

package/dist/protocols/mcp/McpToolSchema.d.ts

@@ -0,0 +1,160 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+import { McpToolDefinition } from './McpServerTypes.js';
+/**
+ * MCP Tool Parameter Type
+ * Represents the possible data types for tool parameters
+ */
+export declare enum McpToolParameterType {
+    STRING = "string",
+    NUMBER = "number",
+    INTEGER = "integer",
+    BOOLEAN = "boolean",
+    ARRAY = "array",
+    OBJECT = "object",
+    NULL = "null"
+}
+/**
+ * MCP Tool Parameter Format
+ * Additional format specifiers for parameters
+ */
+export declare enum McpToolParameterFormat {
+    DATE = "date",
+    DATE_TIME = "date-time",
+    TIME = "time",
+    EMAIL = "email",
+    URI = "uri",
+    UUID = "uuid",
+    REGEX = "regex"
+}
+/**
+ * Tool example for better documentation
+ */
+export interface McpToolExample {
+    input: Record<string, any>;
+    description: string;
+    output?: any;
+}
+/**
+ * Enhanced MCP Tool Definition with examples and metadata
+ */
+export interface EnhancedMcpToolDefinition extends McpToolDefinition {
+    examples?: McpToolExample[];
+    metadata?: {
+        timeout?: number;
+        requiresConfirmation?: boolean;
+        streaming?: boolean;
+        category?: string;
+    };
+}
+/**
+ * MCP Tool Parameter Definition
+ * Represents a parameter for an MCP tool
+ */
+export interface McpToolParameterDefinition {
+    /** Parameter name */
+    name: string;
+    /** Parameter description */
+    description: string;
+    /** Parameter type */
+    type: McpToolParameterType | McpToolParameterType[];
+    /** Is parameter required */
+    required: boolean;
+    /** Parameter format (optional) */
+    format?: McpToolParameterFormat;
+    /** Default value (optional) */
+    default?: any;
+    /** Minimum value for numbers (optional) */
+    minimum?: number;
+    /** Maximum value for numbers (optional) */
+    maximum?: number;
+    /** Minimum length for strings/arrays (optional) */
+    minLength?: number;
+    /** Maximum length for strings/arrays (optional) */
+    maxLength?: number;
+    /** Pattern for strings (optional) */
+    pattern?: string;
+    /** Enum values (optional) */
+    enum?: any[];
+    /** Items schema for arrays (optional) */
+    items?: McpToolParameterDefinition;
+    /** Properties for objects (optional) */
+    properties?: Record<string, McpToolParameterDefinition>;
+    /** Required properties for objects (optional) */
+    requiredProperties?: string[];
+    /** Additional properties allowed for objects (optional) */
+    additionalProperties?: boolean;
+}
+/**
+ * Validation result with detailed error information
+ */
+export interface ValidationResult {
+    valid: boolean;
+    errors?: string[];
+    errorDetails?: Array<{
+        path: string;
+        message: string;
+        expected?: any;
+        actual?: any;
+    }>;
+    coercedInput?: any;
+}
+/**
+ * Create JSON schema from parameter definitions
+ * @param parameters - List of parameter definitions
+ * @returns JSON schema object
+ */
+export declare const createParameterSchema: (parameters: McpToolParameterDefinition[]) => Record<string, any>;
+/**
+ * Create an enhanced MCP tool definition with examples
+ * @param name - Tool name
+ * @param description - Tool description
+ * @param parameters - Tool parameters
+ * @param handler - Tool handler function
+ * @param options - Additional options like examples and metadata
+ * @returns Enhanced MCP tool definition
+ */
+export declare const createToolDefinition: (name: string, description: string, parameters: McpToolParameterDefinition[], handler: McpToolDefinition["handler"], options?: {
+    examples?: McpToolExample[];
+    metadata?: EnhancedMcpToolDefinition["metadata"];
+}) => EnhancedMcpToolDefinition;
+/**
+ * Validate tool input against schema with detailed error reporting
+ * @param schema - JSON schema
+ * @param input - Tool input to validate
+ * @returns Detailed validation result
+ */
+export declare const validateToolInput: (schema: Record<string, any>, input: any) => ValidationResult;
+/**
+ * Format validation errors for user-friendly display
+ * @param result - Validation result
+ * @param toolName - Name of the tool
+ * @param schema - Tool schema
+ * @param input - Input that was validated
+ * @returns Formatted error message
+ */
+export declare const formatValidationError: (result: ValidationResult, toolName: string, schema: Record<string, any>, input: any) => string;
+/**
+ * Generate tool usage documentation with examples
+ * @param tool - Tool definition
+ * @returns Formatted documentation string
+ */
+export declare const generateToolDocumentation: (tool: EnhancedMcpToolDefinition) => string;
+//# sourceMappingURL=McpToolSchema.d.ts.map

package/dist/protocols/mcp/McpToolSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpToolSchema.d.ts","sourceRoot":"","sources":["../../../src/protocols/mcp/McpToolSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAcH,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAuBxD;;;GAGG;AACH,oBAAY,oBAAoB;IAC5B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,IAAI,SAAS;CAChB;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAC9B,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,GAAG,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAC/B,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACvC,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,IAAI,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAC;IACpD,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,kCAAkC;IAClC,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,+BAA+B;IAC/B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,yCAAyC;IACzC,KAAK,CAAC,EAAE,0BAA0B,CAAC;IACnC,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACxD,iDAAiD;IACjD,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,2DAA2D;IAC3D,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,CAAC,EAAE,KAAK,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,MAAM,CAAC,EAAE,GAAG,CAAC;KAChB,CAAC,CAAC;IAEH,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAAI,YAAY,0BAA0B,EAAE,KAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CA0ElG,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,GAC7B,MAAM,MAAM,EACZ,aAAa,MAAM,EACnB,YAAY,0BAA0B,EAAE,EACxC,SAAS,iBAAiB,CAAC,SAAS,CAAC,EACrC,UAAU;IACN,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,yBAAyB,CAAC,UAAU,CAAC,CAAC;CACpD,KACF,yBAiBF,CAAC;AAuJF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,GAAG,KAAG,gBAwH3E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,gBAAgB,EACxB,UAAU,MAAM,EAChB,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,OAAO,GAAG,KACX,MAuCF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GAAI,MAAM,yBAAyB,KAAG,MAmD3E,CAAC"}