fa-mcp-sdk 0.4.3 → 0.4.6

package/src/template/tools/handle-tool-call.ts

@@ -1,56 +1,57 @@
-import { logger as lgr, formatToolResult, ToolExecutionError } from '../../core/index.js';
-import chalk from 'chalk';
-
-const logger = lgr.getSubLogger({ name: chalk.bgGrey('tools') });
-
-/**
- * Template tool handler - customize this for your specific tools
- * This handles MCP tool execution requests
- */
-export const handleToolCall = async (params: { name: string, arguments?: any }): Promise<any> => {
-  const { name, arguments: args } = params;
-
-  logger.info(`Tool called: ${name}`);
-
-  try {
-    // TODO: Implement your tool routing logic here
-    switch (name) {
-      case 'example_tool':
-        return await handleExampleTool(args);
-
-      default:
-        throw new ToolExecutionError(name, `Unknown tool: ${name}`);
-    }
-  } catch (error: Error | any) {
-    logger.error(`Tool execution failed for ${name}:`, error);
-    error.printed = true;
-    throw error;
-  }
-};
-
-/**
- * Example tool implementation
- * Replace this with your actual tool logic
- */
-async function handleExampleTool (args: any): Promise<string> {
-  const { query } = args || {};
-
-  if (!query) {
-    throw new ToolExecutionError('example_tool', 'Query parameter is required');
-  }
-
-  // Simulate some work
-  await new Promise(resolve => setTimeout(resolve, 100));
-
-  const result = {
-    message: `Processed query: ${query}`,
-    timestamp: new Date().toISOString(),
-  };
-
-  return formatToolResult(result);
-}
-
-// TODO: Add more tool handlers here
-// async function handleAnotherTool(args: any): Promise<string> {
-//   // Your implementation
-// }
+import chalk from 'chalk';
+
+import { logger as lgr, formatToolResult, ToolExecutionError } from '../../core/index.js';
+
+const logger = lgr.getSubLogger({ name: chalk.bgGrey('tools') });
+
+/**
+ * Template tool handler - customize this for your specific tools
+ * This handles MCP tool execution requests
+ */
+export const handleToolCall = async (params: { name: string, arguments?: any }): Promise<any> => {
+  const { name, arguments: args } = params;
+
+  logger.info(`Tool called: ${name}`);
+
+  try {
+    // TODO: Implement your tool routing logic here
+    switch (name) {
+      case 'example_tool':
+        return await handleExampleTool(args);
+
+      default:
+        throw new ToolExecutionError(name, `Unknown tool: ${name}`);
+    }
+  } catch (error: Error | any) {
+    logger.error(`Tool execution failed for ${name}:`, error);
+    error.printed = true;
+    throw error;
+  }
+};
+
+/**
+ * Example tool implementation
+ * Replace this with your actual tool logic
+ */
+async function handleExampleTool (args: any): Promise<string> {
+  const { query } = args || {};
+
+  if (!query) {
+    throw new ToolExecutionError('example_tool', 'Query parameter is required');
+  }
+
+  // Simulate some work
+  await new Promise(resolve => setTimeout(resolve, 100));
+
+  const result = {
+    message: `Processed query: ${query}`,
+    timestamp: new Date().toISOString(),
+  };
+
+  return formatToolResult(result);
+}
+
+// TODO: Add more tool handlers here
+// async function handleAnotherTool(args: any): Promise<string> {
+//   // Your implementation
+// }

package/src/template/tools/tools.ts

@@ -1,88 +1,89 @@
-import { Tool } from '@modelcontextprotocol/sdk/types.js';
-import { IToolInputSchema, IToolProperties } from '../../core/index.js';
-
-/**
- * Template tools configuration for MCP Server
- * Define your tools according to your server's functionality
- */
-
-
-const getGenericInputSchema = (
-  queryDescription?: string,
-  additionalProperties?: IToolProperties,
-): IToolInputSchema => {
-  const properties = {
-    query: {
-      type: 'string',
-      description: queryDescription || 'Input query or text',
-    },
-    ...additionalProperties,
-  };
-
-  return {
-    type: 'object',
-    properties,
-    required: ['query'],
-  };
-};
-
-const getSearchInputSchema = (): IToolInputSchema => {
-  return {
-    type: 'object',
-    properties: {
-      query: {
-        type: 'string',
-        description: 'Search query',
-      },
-      limit: {
-        type: 'number',
-        description: 'Maximum number of results to return (1-100, default: 20)',
-        minimum: 1,
-        maximum: 100,
-      },
-      threshold: {
-        type: 'number',
-        description: 'Minimum similarity threshold (0-1)',
-        minimum: 0,
-        maximum: 1,
-      },
-    },
-    required: ['query'],
-  };
-};
-
-// Template tools - customize according to your needs
-export const tools: Tool[] = [
-  {
-    name: 'example_tool',
-    description: 'Example tool that processes text input. Replace with your actual tools.',
-    inputSchema: getGenericInputSchema('Text to process'),
-  },
-  {
-    name: 'example_search',
-    description: 'Example search tool with pagination and filtering. Template for search-based tools.',
-    inputSchema: getSearchInputSchema(),
-  },
-  // TODO: Add your actual tools here
-  // {
-  //   name: 'your_tool_name',
-  //   description: 'Description of what your tool does',
-  //   inputSchema: getGenericInputSchema('Your query description', {
-  //     // additional parameters
-  //     param1: {
-  //       type: 'string',
-  //       description: 'Description of param1',
-  //     },
-  //   }),
-  // },
-];
-
-// Helper to get tool by name
-export const getToolByName = (name: string): Tool | undefined => {
-  return tools.find(tool => tool.name === name);
-};
-
-// Helper to get all tool names
-export const getToolNames = (): string[] => {
-  return tools.map(tool => tool.name);
-};
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+
+import { IToolInputSchema, IToolProperties } from '../../core/index.js';
+
+/**
+ * Template tools configuration for MCP Server
+ * Define your tools according to your server's functionality
+ */
+
+
+const getGenericInputSchema = (
+  queryDescription?: string,
+  additionalProperties?: IToolProperties,
+): IToolInputSchema => {
+  const properties = {
+    query: {
+      type: 'string',
+      description: queryDescription || 'Input query or text',
+    },
+    ...additionalProperties,
+  };
+
+  return {
+    type: 'object',
+    properties,
+    required: ['query'],
+  };
+};
+
+const getSearchInputSchema = (): IToolInputSchema => {
+  return {
+    type: 'object',
+    properties: {
+      query: {
+        type: 'string',
+        description: 'Search query',
+      },
+      limit: {
+        type: 'number',
+        description: 'Maximum number of results to return (1-100, default: 20)',
+        minimum: 1,
+        maximum: 100,
+      },
+      threshold: {
+        type: 'number',
+        description: 'Minimum similarity threshold (0-1)',
+        minimum: 0,
+        maximum: 1,
+      },
+    },
+    required: ['query'],
+  };
+};
+
+// Template tools - customize according to your needs
+export const tools: Tool[] = [
+  {
+    name: 'example_tool',
+    description: 'Example tool that processes text input. Replace with your actual tools.',
+    inputSchema: getGenericInputSchema('Text to process'),
+  },
+  {
+    name: 'example_search',
+    description: 'Example search tool with pagination and filtering. Template for search-based tools.',
+    inputSchema: getSearchInputSchema(),
+  },
+  // TODO: Add your actual tools here
+  // {
+  //   name: 'your_tool_name',
+  //   description: 'Description of what your tool does',
+  //   inputSchema: getGenericInputSchema('Your query description', {
+  //     // additional parameters
+  //     param1: {
+  //       type: 'string',
+  //       description: 'Description of param1',
+  //     },
+  //   }),
+  // },
+];
+
+// Helper to get tool by name
+export const getToolByName = (name: string): Tool | undefined => {
+  return tools.find(tool => tool.name === name);
+};
+
+// Helper to get all tool names
+export const getToolNames = (): string[] => {
+  return tools.map(tool => tool.name);
+};

package/src/tests/jest-simple-reporter.js

@@ -1,10 +1,10 @@
-export default class SimpleReporter {
-  onRunComplete (contexts, runResults) {
-    const { numPassedTests, numFailedTests, numPendingTests } = runResults;
-    const total = numPassedTests + numFailedTests + numPendingTests;
-    const actualSuccess = numFailedTests === 0 && total > 0;
-
-    console.log(`\nTest Results: ${numPassedTests} passed, ${numFailedTests} failed, ${numPendingTests} skipped (${total} total)`);
-    console.log(`Status: ${actualSuccess ? 'PASSED' : 'FAILED'}`);
-  }
-}
+export default class SimpleReporter {
+  onRunComplete (contexts, runResults) {
+    const { numPassedTests, numFailedTests, numPendingTests } = runResults;
+    const total = numPassedTests + numFailedTests + numPendingTests;
+    const actualSuccess = numFailedTests === 0 && total > 0;
+
+    console.log(`\nTest Results: ${numPassedTests} passed, ${numFailedTests} failed, ${numPendingTests} skipped (${total} total)`);
+    console.log(`Status: ${actualSuccess ? 'PASSED' : 'FAILED'}`);
+  }
+}

package/src/tests/mcp/sse/test-sse-npm-package.js

@@ -1,96 +1,96 @@
-#!/usr/bin/env node
-
-/**
- * Example of using fa-mcp-sdk as an npm package without unhandledRejection issues
- *
- * To use this example:
- * 1. Install fa-mcp-sdk: npm install fa-mcp-sdk
- * 2. Start MCP server: npm run template:start (in fa-mcp-sdk project)
- * 3. Run this example: node test-npm-package.js
- */
-
-import { McpSseClient } from 'fa-mcp-sdk';
-
-const SERVER_URL = 'http://localhost:9876';
-
-async function testMcpClient () {
-  console.log('🧪 Testing MCP client as npm package');
-  console.log('='.repeat(50));
-
-  // Use the new method that handles unhandledRejection
-  const client = McpSseClient.createWithErrorHandler(SERVER_URL);
-
-  try {
-    // Health check
-    console.log('1. Health check...');
-    try {
-      const health = await client.health();
-      console.log('✅ Health check passed:', health.status);
-    } catch (error) {
-      console.log('⚠️  Health check failed:', error.message);
-    }
-
-    // Initialize
-    console.log('2. Initializing...');
-    await client.sendRequest('initialize', {
-      protocolVersion: '2024-11-05',
-      capabilities: { tools: {} },
-      clientInfo: { name: 'npm-test', version: '1.0.0' },
-    });
-    console.log('✅ Initialized successfully');
-
-    // List tools
-    console.log('3. Listing tools...');
-    const tools = await client.listTools();
-    const toolNames = tools.tools?.map(t => t.name) || [];
-    console.log('✅ Available tools:', toolNames.join(', '));
-
-    // Test successful tool call
-    console.log('4. Testing successful tool call...');
-    try {
-      const response = await client.callTool('example_tool', { query: 'ping' });
-      console.log('✅ Tool call successful:', response.result?.structuredContent?.message || response.result?.content?.[0]?.text);
-    } catch (error) {
-      console.log('❌ Tool call failed:', error.message);
-    }
-
-    // Test expected error (like the test case in test-cases.js)
-    console.log('5. Testing expected error handling...');
-    try {
-      await client.callTool('example_tool', {}); // Missing query parameter
-      console.log('❌ Expected error but got success');
-    } catch (error) {
-      console.log('✅ Expected error caught:', error.message);
-      // This error should NOT cause unhandledRejection
-    }
-
-    // Test with invalid tool name
-    console.log('6. Testing invalid tool name...');
-    try {
-      await client.callTool('nonexistent_tool', {});
-      console.log('❌ Expected error but got success');
-    } catch (error) {
-      console.log('✅ Expected error caught:', error.message);
-      // This error should NOT cause unhandledRejection
-    }
-
-    console.log('\n🎉 All tests completed successfully!');
-    console.log('✨ No unhandledRejection errors occurred');
-
-  } catch (error) {
-    console.error('❌ Unexpected error:', error.message);
-  } finally {
-    await client.close();
-    console.log('🔚 Client closed');
-  }
-}
-
-// Global handler for any unexpected unhandled rejections
-process.on('unhandledRejection', (reason, promise) => {
-  console.error('💥 UNHANDLED REJECTION (this should not happen):');
-  console.error('Reason:', reason);
-  console.error('Promise:', promise);
-  process.exit(1);
-});
-
-testMcpClient().catch(console.error);
+#!/usr/bin/env node
+
+/**
+ * Example of using fa-mcp-sdk as an npm package without unhandledRejection issues
+ *
+ * To use this example:
+ * 1. Install fa-mcp-sdk: npm install fa-mcp-sdk
+ * 2. Start MCP server: npm run template:start (in fa-mcp-sdk project)
+ * 3. Run this example: node test-npm-package.js
+ */
+
+import { McpSseClient } from 'fa-mcp-sdk';
+
+const SERVER_URL = 'http://localhost:9876';
+
+async function testMcpClient () {
+  console.log('🧪 Testing MCP client as npm package');
+  console.log('='.repeat(50));
+
+  // Use the new method that handles unhandledRejection
+  const client = McpSseClient.createWithErrorHandler(SERVER_URL);
+
+  try {
+    // Health check
+    console.log('1. Health check...');
+    try {
+      const health = await client.health();
+      console.log('✅ Health check passed:', health.status);
+    } catch (error) {
+      console.log('⚠️  Health check failed:', error.message);
+    }
+
+    // Initialize
+    console.log('2. Initializing...');
+    await client.sendRequest('initialize', {
+      protocolVersion: '2024-11-05',
+      capabilities: { tools: {} },
+      clientInfo: { name: 'npm-test', version: '1.0.0' },
+    });
+    console.log('✅ Initialized successfully');
+
+    // List tools
+    console.log('3. Listing tools...');
+    const tools = await client.listTools();
+    const toolNames = tools.tools?.map(t => t.name) || [];
+    console.log('✅ Available tools:', toolNames.join(', '));
+
+    // Test successful tool call
+    console.log('4. Testing successful tool call...');
+    try {
+      const response = await client.callTool('example_tool', { query: 'ping' });
+      console.log('✅ Tool call successful:', response.result?.structuredContent?.message || response.result?.content?.[0]?.text);
+    } catch (error) {
+      console.log('❌ Tool call failed:', error.message);
+    }
+
+    // Test expected error (like the test case in test-cases.js)
+    console.log('5. Testing expected error handling...');
+    try {
+      await client.callTool('example_tool', {}); // Missing query parameter
+      console.log('❌ Expected error but got success');
+    } catch (error) {
+      console.log('✅ Expected error caught:', error.message);
+      // This error should NOT cause unhandledRejection
+    }
+
+    // Test with invalid tool name
+    console.log('6. Testing invalid tool name...');
+    try {
+      await client.callTool('nonexistent_tool', {});
+      console.log('❌ Expected error but got success');
+    } catch (error) {
+      console.log('✅ Expected error caught:', error.message);
+      // This error should NOT cause unhandledRejection
+    }
+
+    console.log('\n🎉 All tests completed successfully!');
+    console.log('✨ No unhandledRejection errors occurred');
+
+  } catch (error) {
+    console.error('❌ Unexpected error:', error.message);
+  } finally {
+    await client.close();
+    console.log('🔚 Client closed');
+  }
+}
+
+// Global handler for any unexpected unhandled rejections
+process.on('unhandledRejection', (reason, promise) => {
+  console.error('💥 UNHANDLED REJECTION (this should not happen):');
+  console.error('Reason:', reason);
+  console.error('Promise:', promise);
+  process.exit(1);
+});
+
+testMcpClient().catch(console.error);