fa-mcp-sdk 0.4.3 → 0.4.6

package/src/tests/mcp/test-stdio.js

@@ -1,81 +1,83 @@
-#!/usr/bin/env node
-
-/**
- * STDIO transport tests for the template MCP server (src/template)
- * Uses a minimal NDJSON JSON-RPC client over child_process stdio
- */
-
-import { spawn } from 'child_process';
-import { fileURLToPath } from 'url';
-import { dirname, join } from 'path';
-import TEMPLATE_TESTS from './test-cases.js';
-import { McpStdioClient } from '../../../dist/core/index.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-const serverPath = join(__dirname, '../../../dist/template/start.js');
-
-async function runTestGroup (title, tests, client) {
-  console.log(`\n${title}:`);
-  let passed = 0;
-  for (const test of tests) {
-    const name = (await test).name || 'test';
-    try {
-      const res = await test(client);
-      if (res.passed) {
-        console.log(`  ✅  ${res.name}`);
-        passed++;
-      } else {
-        console.log(`  ❌  ${res.name}`);
-        if (res.details) {
-          console.log('     ', res.details);
-        }
-      }
-    } catch (e) {
-      console.log(`  ❌  ${name}:`, e.message);
-    }
-  }
-  console.log(`  Result: ${passed}/${tests.length} passed`);
-  return passed;
-}
-
-async function main () {
-  console.log('🧪 STDIO tests for template MCP server');
-  console.log('='.repeat(60));
-
-  const proc = spawn('node', [serverPath, 'stdio'], {
-    stdio: ['pipe', 'pipe', 'pipe'],
-    env: { ...process.env, NODE_ENV: 'test' },
-  });
-
-  const client = new McpStdioClient(proc);
-
-  try {
-    // Initialize handshake (optional for stdio server; safe to send)
-    await client.send('initialize', {
-      protocolVersion: '2024-11-05',
-      capabilities: { tools: {} },
-      clientInfo: { name: 'stdio-test', version: '1.0.0' },
-    }).catch(() => undefined);
-
-    const p1 = await runTestGroup('Prompts', TEMPLATE_TESTS.prompts, client);
-    const p2 = await runTestGroup('Resources', TEMPLATE_TESTS.resources, client);
-    const p3 = await runTestGroup('Tools', TEMPLATE_TESTS.tools, client);
-
-    const total = TEMPLATE_TESTS.prompts.length + TEMPLATE_TESTS.resources.length + TEMPLATE_TESTS.tools.length;
-    const sum = p1 + p2 + p3;
-    console.log(`\nSummary: ${sum}/${total} tests passed`);
-  } finally {
-    try { proc.kill(); } catch {}
-  }
-}
-
-main()
-  .then(() => {
-    process.exit(0);
-  })
-  .catch((e) => {
-    console.error('Test failed:', e?.message || e);
-    process.exit(1);
-  });
+#!/usr/bin/env node
+
+/**
+ * STDIO transport tests for the template MCP server (src/template)
+ * Uses a minimal NDJSON JSON-RPC client over child_process stdio
+ */
+
+import { spawn } from 'child_process';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+
+import { McpStdioClient } from '../../../dist/core/index.js';
+
+import TEMPLATE_TESTS from './test-cases.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const serverPath = join(__dirname, '../../../dist/template/start.js');
+
+async function runTestGroup (title, tests, client) {
+  console.log(`\n${title}:`);
+  let passed = 0;
+  for (const test of tests) {
+    const name = (await test).name || 'test';
+    try {
+      const res = await test(client);
+      if (res.passed) {
+        console.log(`  ✅  ${res.name}`);
+        passed++;
+      } else {
+        console.log(`  ❌  ${res.name}`);
+        if (res.details) {
+          console.log('     ', res.details);
+        }
+      }
+    } catch (e) {
+      console.log(`  ❌  ${name}:`, e.message);
+    }
+  }
+  console.log(`  Result: ${passed}/${tests.length} passed`);
+  return passed;
+}
+
+async function main () {
+  console.log('🧪 STDIO tests for template MCP server');
+  console.log('='.repeat(60));
+
+  const proc = spawn('node', [serverPath, 'stdio'], {
+    stdio: ['pipe', 'pipe', 'pipe'],
+    env: { ...process.env, NODE_ENV: 'test' },
+  });
+
+  const client = new McpStdioClient(proc);
+
+  try {
+    // Initialize handshake (optional for stdio server; safe to send)
+    await client.send('initialize', {
+      protocolVersion: '2024-11-05',
+      capabilities: { tools: {} },
+      clientInfo: { name: 'stdio-test', version: '1.0.0' },
+    }).catch(() => undefined);
+
+    const p1 = await runTestGroup('Prompts', TEMPLATE_TESTS.prompts, client);
+    const p2 = await runTestGroup('Resources', TEMPLATE_TESTS.resources, client);
+    const p3 = await runTestGroup('Tools', TEMPLATE_TESTS.tools, client);
+
+    const total = TEMPLATE_TESTS.prompts.length + TEMPLATE_TESTS.resources.length + TEMPLATE_TESTS.tools.length;
+    const sum = p1 + p2 + p3;
+    console.log(`\nSummary: ${sum}/${total} tests passed`);
+  } finally {
+    try { proc.kill(); } catch {}
+  }
+}
+
+main()
+  .then(() => {
+    process.exit(0);
+  })
+  .catch((e) => {
+    console.error('Test failed:', e?.message || e);
+    process.exit(1);
+  });

package/src/tests/utils.ts

@@ -1,156 +1,157 @@
-import fsp from 'fs/promises';
-import fss from 'fs';
-import path from 'path';
-import chalk from 'chalk';
-import * as dotenv from 'dotenv';
-
-dotenv.config({ quiet: true, path: path.join(process.cwd(), '.env') });
-
-const testResultLogsDir = process.env.TEST_RESULT_LOGS_DIR || '_logs/mcp';
-
-const RESULTS_DIR = path.join(process.cwd(), testResultLogsDir);
-
-if (!fss.existsSync(RESULTS_DIR)) {
-  fss.mkdirSync(RESULTS_DIR, { recursive: true });
-}
-
-export interface ITestResult {
-  // Test / tool identifiers
-  fullId: string;
-  toolName: string;
-  description: string;
-
-  // Tool invocation parameters
-  parameters: unknown | null;
-
-  // Temporal metadata
-  timestamp: string; // ISO string
-  duration: number;  // milliseconds
-
-  // Execution status
-  status: 'pending' | 'passed' | 'failed' | 'skipped' | 'expected_failure';
-
-  // Marker icon for logs (may be absent in "pending")
-  marker?: string;
-
-  // MCP response
-  response: unknown | null;
-
-  // Error (human-readable message)
-  error: string | null;
-
-  // Additional error details (structured)
-  errorDetails?: unknown | null;
-
-  // Full MCP response on error (JSON-RPC response)
-  fullMcpResponse?: unknown;
-
-  // Request headers used for the MCP server call
-  requestHeaders?: Record<string, string>;
-}
-
-/**
- * Format test result as Markdown
- */
-export const formatResultAsMarkdown = (result: ITestResult) => {
-  const t = '```';
-  const mdText = (s: string | null) => `${t}\n${s}\n${t}`;
-  const mdDescr = (s: string) => `${t}description\n${s}\n${t}`;
-  const mdJson = (v: any) => `${t}json\n${v && JSON.stringify(v, null, 2)}\n${t}`;
-
-  let resultStatus = '⚠️ RESULT STATUS UNKNOWN';
-  let errorText = '';
-  // md += `## Response\n\n\`\`\`json\n${JSON.stringify(result.response, null, 2)}\n\`\`\`\n\n`;
-
-  if (result.status === 'passed') {
-    resultStatus = '✅  PASSED';
-  } else {
-    // Show full MCP response as seen by the agent, or fallback to separate sections
-    if (result.fullMcpResponse) {
-      errorText = `## MCP Response (as seen by agent)\n\n${mdJson(result.fullMcpResponse)}\n\n`;
-    } else {
-      errorText = `## Error\n\n${mdText(result.error)}\n\n`;
-      // Add detailed error information if available
-      if (result.errorDetails) {
-        errorText += `## Error Details\n\n${mdJson(result.errorDetails)}\n\n`;
-      }
-    }
-    if (result.status === 'expected_failure') {
-      resultStatus = '⚠️  Expected failure - test validation successful';
-    } else {
-      resultStatus = '❌  FAILED';
-    }
-  }
-
-  let requestHeaders = '';
-  if (result.requestHeaders && Object.keys(result.requestHeaders).length > 0) {
-    requestHeaders = `\nHeaders:\n${Object.entries(result.requestHeaders).map(([k, v]) => `  ${k}: ${v}`).join('\n')}\n`;
-  }
-
-  // Format response section
-  let responseText = '';
-  if (result.response !== null && result.response !== undefined) {
-    try {
-      let parsedResponse: any = result.response;
-      let isJsonParsed = false;
-
-      // If response is a string, try to parse as JSON first
-      if (typeof result.response === 'string') {
-        try {
-          parsedResponse = JSON.parse(result.response);
-          isJsonParsed = true;
-        } catch {
-          // If not valid JSON, treat as text
-          responseText = `## Response\n\n${mdText(result.response)}\n\n`;
-        }
-      } else if (typeof result.response === 'object') {
-        isJsonParsed = true;
-      }
-
-      // If we have a successfully parsed or original object
-      if (isJsonParsed && typeof parsedResponse === 'object') {
-        let text = parsedResponse;
-        let addText = '';
-        // Check if response has content[0].text structure and extract text
-        if (Array.isArray(parsedResponse?.content) && parsedResponse.content[0]?.text) {
-          const textContent = parsedResponse.content[0].text;
-          parsedResponse.content[0].text = '📋';
-          text = parsedResponse;
-          addText = `## Formatted Text 📋\n${mdText(textContent)}\n\n`;
-        }
-        responseText = `## Response\n\n${mdJson(text)}\n\n${addText}`;
-      }
-
-    } catch {
-      // Fallback to text if any parsing errors
-      responseText = `## Response\n\n${mdText(String(result.response))}\n\n`;
-    }
-  }
-
-  return `${resultStatus} / ${result.timestamp} / ${result.duration}ms
-# ${result.toolName}
-${requestHeaders}
-${mdDescr(result.description)}
-
-parameters:
-${mdJson(result.parameters)}
-
-${responseText}${errorText}`;
-};
-
-/**
- * Log test result to individual file
- */
-export const logResultToFile = async (result: ITestResult) => {
-  // const filename = `${result.fullId}_${result.toolName}.md`;
-  const filename = `${result.toolName}.md`;
-  const filepath = path.join(RESULTS_DIR, filename);
-
-  const content = formatResultAsMarkdown(result);
-
-  try {
-    await fsp.writeFile(filepath, content, 'utf-8');
-  } catch (error: Error | any) {
-    console.log(chalk.red(`  Failed to write log file: ${error.message}`));
-  }
-};
+import fss from 'fs';
+import fsp from 'fs/promises';
+import path from 'path';
+
+import chalk from 'chalk';
+import * as dotenv from 'dotenv';
+
+dotenv.config({ quiet: true, path: path.join(process.cwd(), '.env') });
+
+const testResultLogsDir = process.env.TEST_RESULT_LOGS_DIR || '_logs/mcp';
+
+const RESULTS_DIR = path.join(process.cwd(), testResultLogsDir);
+
+if (!fss.existsSync(RESULTS_DIR)) {
+  fss.mkdirSync(RESULTS_DIR, { recursive: true });
+}
+
+export interface ITestResult {
+  // Test / tool identifiers
+  fullId: string;
+  toolName: string;
+  description: string;
+
+  // Tool invocation parameters
+  parameters: unknown | null;
+
+  // Temporal metadata
+  timestamp: string; // ISO string
+  duration: number;  // milliseconds
+
+  // Execution status
+  status: 'pending' | 'passed' | 'failed' | 'skipped' | 'expected_failure';
+
+  // Marker icon for logs (may be absent in "pending")
+  marker?: string;
+
+  // MCP response
+  response: unknown | null;
+
+  // Error (human-readable message)
+  error: string | null;
+
+  // Additional error details (structured)
+  errorDetails?: unknown | null;
+
+  // Full MCP response on error (JSON-RPC response)
+  fullMcpResponse?: unknown;
+
+  // Request headers used for the MCP server call
+  requestHeaders?: Record<string, string>;
+}
+
+/**
+ * Format test result as Markdown
+ */
+export const formatResultAsMarkdown = (result: ITestResult) => {
+  const t = '```';
+  const mdText = (s: string | null) => `${t}\n${s}\n${t}`;
+  const mdDescr = (s: string) => `${t}description\n${s}\n${t}`;
+  const mdJson = (v: any) => `${t}json\n${v && JSON.stringify(v, null, 2)}\n${t}`;
+
+  let resultStatus = '⚠️ RESULT STATUS UNKNOWN';
+  let errorText = '';
+  // md += `## Response\n\n\`\`\`json\n${JSON.stringify(result.response, null, 2)}\n\`\`\`\n\n`;
+
+  if (result.status === 'passed') {
+    resultStatus = '✅  PASSED';
+  } else {
+    // Show full MCP response as seen by the agent, or fallback to separate sections
+    if (result.fullMcpResponse) {
+      errorText = `## MCP Response (as seen by agent)\n\n${mdJson(result.fullMcpResponse)}\n\n`;
+    } else {
+      errorText = `## Error\n\n${mdText(result.error)}\n\n`;
+      // Add detailed error information if available
+      if (result.errorDetails) {
+        errorText += `## Error Details\n\n${mdJson(result.errorDetails)}\n\n`;
+      }
+    }
+    if (result.status === 'expected_failure') {
+      resultStatus = '⚠️  Expected failure - test validation successful';
+    } else {
+      resultStatus = '❌  FAILED';
+    }
+  }
+
+  let requestHeaders = '';
+  if (result.requestHeaders && Object.keys(result.requestHeaders).length > 0) {
+    requestHeaders = `\nHeaders:\n${Object.entries(result.requestHeaders).map(([k, v]) => `  ${k}: ${v}`).join('\n')}\n`;
+  }
+
+  // Format response section
+  let responseText = '';
+  if (result.response !== null && result.response !== undefined) {
+    try {
+      let parsedResponse: any = result.response;
+      let isJsonParsed = false;
+
+      // If response is a string, try to parse as JSON first
+      if (typeof result.response === 'string') {
+        try {
+          parsedResponse = JSON.parse(result.response);
+          isJsonParsed = true;
+        } catch {
+          // If not valid JSON, treat as text
+          responseText = `## Response\n\n${mdText(result.response)}\n\n`;
+        }
+      } else if (typeof result.response === 'object') {
+        isJsonParsed = true;
+      }
+
+      // If we have a successfully parsed or original object
+      if (isJsonParsed && typeof parsedResponse === 'object') {
+        let text = parsedResponse;
+        let addText = '';
+        // Check if response has content[0].text structure and extract text
+        if (Array.isArray(parsedResponse?.content) && parsedResponse.content[0]?.text) {
+          const textContent = parsedResponse.content[0].text;
+          parsedResponse.content[0].text = '📋';
+          text = parsedResponse;
+          addText = `## Formatted Text 📋\n${mdText(textContent)}\n\n`;
+        }
+        responseText = `## Response\n\n${mdJson(text)}\n\n${addText}`;
+      }
+
+    } catch {
+      // Fallback to text if any parsing errors
+      responseText = `## Response\n\n${mdText(String(result.response))}\n\n`;
+    }
+  }
+
+  return `${resultStatus} / ${result.timestamp} / ${result.duration}ms
+# ${result.toolName}
+${requestHeaders}
+${mdDescr(result.description)}
+
+parameters:
+${mdJson(result.parameters)}
+
+${responseText}${errorText}`;
+};
+
+/**
+ * Log test result to individual file
+ */
+export const logResultToFile = async (result: ITestResult) => {
+  // const filename = `${result.fullId}_${result.toolName}.md`;
+  const filename = `${result.toolName}.md`;
+  const filepath = path.join(RESULTS_DIR, filename);
+
+  const content = formatResultAsMarkdown(result);
+
+  try {
+    await fsp.writeFile(filepath, content, 'utf-8');
+  } catch (error: Error | any) {
+    console.log(chalk.red(`  Failed to write log file: ${error.message}`));
+  }
+};