@juspay/neurolink 9.51.3 → 9.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/artifacts/artifactStore.d.ts +56 -0
  3. package/dist/artifacts/artifactStore.js +143 -0
  4. package/dist/browser/neurolink.min.js +311 -298
  5. package/dist/cli/commands/mcp.d.ts +6 -0
  6. package/dist/cli/commands/mcp.js +128 -86
  7. package/dist/cli/loop/optionsSchema.d.ts +1 -1
  8. package/dist/core/factory.d.ts +2 -2
  9. package/dist/core/factory.js +4 -4
  10. package/dist/core/redisConversationMemoryManager.js +20 -0
  11. package/dist/factories/providerFactory.d.ts +4 -4
  12. package/dist/factories/providerFactory.js +20 -7
  13. package/dist/factories/providerRegistry.d.ts +5 -0
  14. package/dist/factories/providerRegistry.js +45 -26
  15. package/dist/lib/artifacts/artifactStore.d.ts +56 -0
  16. package/dist/lib/artifacts/artifactStore.js +144 -0
  17. package/dist/lib/core/factory.d.ts +2 -2
  18. package/dist/lib/core/factory.js +4 -4
  19. package/dist/lib/core/redisConversationMemoryManager.js +20 -0
  20. package/dist/lib/factories/providerFactory.d.ts +4 -4
  21. package/dist/lib/factories/providerFactory.js +20 -7
  22. package/dist/lib/factories/providerRegistry.d.ts +5 -0
  23. package/dist/lib/factories/providerRegistry.js +45 -26
  24. package/dist/lib/mcp/externalServerManager.d.ts +6 -0
  25. package/dist/lib/mcp/externalServerManager.js +9 -0
  26. package/dist/lib/mcp/mcpOutputNormalizer.d.ts +49 -0
  27. package/dist/lib/mcp/mcpOutputNormalizer.js +182 -0
  28. package/dist/lib/mcp/toolDiscoveryService.d.ts +10 -0
  29. package/dist/lib/mcp/toolDiscoveryService.js +32 -1
  30. package/dist/lib/memory/memoryRetrievalTools.d.ts +64 -9
  31. package/dist/lib/memory/memoryRetrievalTools.js +77 -9
  32. package/dist/lib/neurolink.d.ts +23 -0
  33. package/dist/lib/neurolink.js +128 -86
  34. package/dist/lib/providers/amazonBedrock.d.ts +6 -1
  35. package/dist/lib/providers/amazonBedrock.js +14 -2
  36. package/dist/lib/providers/amazonSagemaker.d.ts +7 -1
  37. package/dist/lib/providers/amazonSagemaker.js +21 -3
  38. package/dist/lib/providers/anthropic.d.ts +4 -1
  39. package/dist/lib/providers/anthropic.js +18 -5
  40. package/dist/lib/providers/azureOpenai.d.ts +2 -1
  41. package/dist/lib/providers/azureOpenai.js +10 -5
  42. package/dist/lib/providers/googleAiStudio.d.ts +4 -1
  43. package/dist/lib/providers/googleAiStudio.js +6 -7
  44. package/dist/lib/providers/googleVertex.d.ts +3 -1
  45. package/dist/lib/providers/googleVertex.js +96 -17
  46. package/dist/lib/providers/huggingFace.d.ts +2 -1
  47. package/dist/lib/providers/huggingFace.js +4 -4
  48. package/dist/lib/providers/litellm.d.ts +5 -1
  49. package/dist/lib/providers/litellm.js +14 -9
  50. package/dist/lib/providers/mistral.d.ts +2 -1
  51. package/dist/lib/providers/mistral.js +2 -2
  52. package/dist/lib/providers/ollama.d.ts +3 -1
  53. package/dist/lib/providers/ollama.js +2 -2
  54. package/dist/lib/providers/openAI.d.ts +5 -1
  55. package/dist/lib/providers/openAI.js +15 -5
  56. package/dist/lib/providers/openRouter.d.ts +5 -1
  57. package/dist/lib/providers/openRouter.js +17 -5
  58. package/dist/lib/providers/openaiCompatible.d.ts +4 -1
  59. package/dist/lib/providers/openaiCompatible.js +15 -3
  60. package/dist/lib/session/globalSessionState.js +44 -1
  61. package/dist/lib/types/artifactTypes.d.ts +63 -0
  62. package/dist/lib/types/artifactTypes.js +11 -0
  63. package/dist/lib/types/configTypes.d.ts +39 -0
  64. package/dist/lib/types/conversation.d.ts +7 -0
  65. package/dist/lib/types/generateTypes.d.ts +13 -0
  66. package/dist/lib/types/index.d.ts +2 -0
  67. package/dist/lib/types/mcpOutputTypes.d.ts +40 -0
  68. package/dist/lib/types/mcpOutputTypes.js +9 -0
  69. package/dist/lib/types/providers.d.ts +75 -0
  70. package/dist/lib/types/streamTypes.d.ts +7 -1
  71. package/dist/mcp/externalServerManager.d.ts +6 -0
  72. package/dist/mcp/externalServerManager.js +9 -0
  73. package/dist/mcp/mcpOutputNormalizer.d.ts +49 -0
  74. package/dist/mcp/mcpOutputNormalizer.js +181 -0
  75. package/dist/mcp/toolDiscoveryService.d.ts +10 -0
  76. package/dist/mcp/toolDiscoveryService.js +32 -1
  77. package/dist/memory/memoryRetrievalTools.d.ts +64 -9
  78. package/dist/memory/memoryRetrievalTools.js +77 -9
  79. package/dist/neurolink.d.ts +23 -0
  80. package/dist/neurolink.js +128 -86
  81. package/dist/providers/amazonBedrock.d.ts +6 -1
  82. package/dist/providers/amazonBedrock.js +14 -2
  83. package/dist/providers/amazonSagemaker.d.ts +7 -1
  84. package/dist/providers/amazonSagemaker.js +21 -3
  85. package/dist/providers/anthropic.d.ts +4 -1
  86. package/dist/providers/anthropic.js +18 -5
  87. package/dist/providers/azureOpenai.d.ts +2 -1
  88. package/dist/providers/azureOpenai.js +10 -5
  89. package/dist/providers/googleAiStudio.d.ts +4 -1
  90. package/dist/providers/googleAiStudio.js +6 -7
  91. package/dist/providers/googleVertex.d.ts +3 -1
  92. package/dist/providers/googleVertex.js +96 -17
  93. package/dist/providers/huggingFace.d.ts +2 -1
  94. package/dist/providers/huggingFace.js +4 -4
  95. package/dist/providers/litellm.d.ts +5 -1
  96. package/dist/providers/litellm.js +14 -9
  97. package/dist/providers/mistral.d.ts +2 -1
  98. package/dist/providers/mistral.js +2 -2
  99. package/dist/providers/ollama.d.ts +3 -1
  100. package/dist/providers/ollama.js +2 -2
  101. package/dist/providers/openAI.d.ts +5 -1
  102. package/dist/providers/openAI.js +15 -5
  103. package/dist/providers/openRouter.d.ts +5 -1
  104. package/dist/providers/openRouter.js +17 -5
  105. package/dist/providers/openaiCompatible.d.ts +4 -1
  106. package/dist/providers/openaiCompatible.js +15 -3
  107. package/dist/session/globalSessionState.js +44 -1
  108. package/dist/types/artifactTypes.d.ts +63 -0
  109. package/dist/types/artifactTypes.js +10 -0
  110. package/dist/types/configTypes.d.ts +39 -0
  111. package/dist/types/conversation.d.ts +7 -0
  112. package/dist/types/generateTypes.d.ts +13 -0
  113. package/dist/types/index.d.ts +2 -0
  114. package/dist/types/mcpOutputTypes.d.ts +40 -0
  115. package/dist/types/mcpOutputTypes.js +8 -0
  116. package/dist/types/providers.d.ts +75 -0
  117. package/dist/types/streamTypes.d.ts +7 -1
  118. package/package.json +3 -2
@@ -67,6 +67,12 @@ export declare class MCPCommandFactory {
67
67
  * Execute exec command
68
68
  */
69
69
  private static executeExec;
70
+ /**
71
+ * Run the actual MCP tool execution and format/write the output.
72
+ * Extracted to keep executeExec nesting within ESLint max-depth limit.
73
+ * Returns 0 on success, 1 on failure.
74
+ */
75
+ private static runExecTool;
70
76
  /**
71
77
  * Execute remove command
72
78
  */
@@ -656,104 +656,146 @@ export class MCPCommandFactory {
656
656
  }
657
657
  }
658
658
  const sdk = new NeuroLink();
659
- await this.getMCPStatusWithTimeout(sdk);
660
- // Check if server exists and is connected
661
- const allServers = await sdk.listMCPServers();
662
- const server = allServers.find((s) => s.name === serverName);
663
- if (!server) {
664
- if (spinner) {
665
- spinner.fail();
666
- }
667
- logger.error(chalk.red(`❌ Server not found: ${serverName}`));
668
- process.exit(1);
669
- }
670
- if (server.status !== "connected") {
671
- if (spinner) {
672
- spinner.fail();
673
- }
674
- logger.error(chalk.red(`❌ Server not connected: ${serverName}`));
675
- logger.always(chalk.yellow("💡 Try: neurolink mcp test " + serverName));
676
- process.exit(1);
677
- }
678
- // Check if tool exists
679
- const tool = server.tools?.find((t) => t.name === toolName);
680
- if (!tool) {
681
- if (spinner) {
682
- spinner.fail();
683
- }
684
- logger.error(chalk.red(`❌ Tool not found: ${toolName}`));
685
- if (server.tools?.length) {
686
- logger.always(chalk.blue("Available tools:"));
687
- server.tools.forEach((t) => {
688
- logger.always(` • ${t.name}: ${t.description}`);
689
- });
690
- }
691
- process.exit(1);
692
- }
693
- // Execute the tool using the NeuroLink MCP tool registry
659
+ let exitCode = 0;
694
660
  try {
695
- const { toolRegistry } = await import("../../lib/mcp/toolRegistry.js");
696
- const executionResult = await toolRegistry.executeTool(toolName, params, {
697
- sessionId: `cli-${Date.now()}`,
698
- userId: process.env.USER || "cli-user",
699
- config: {
700
- domainType: "cli-execution",
701
- customData: { serverName },
702
- },
703
- });
704
- const result = {
705
- tool: toolName,
706
- server: serverName,
707
- params,
708
- result: executionResult,
709
- success: true,
710
- timestamp: new Date().toISOString(),
711
- };
712
- if (spinner) {
713
- spinner.succeed(chalk.green("✅ Tool executed successfully"));
714
- }
715
- // Display results
716
- if (argv.format === "json") {
717
- logger.always(JSON.stringify(result, null, 2));
718
- }
719
- else {
720
- logger.always(chalk.green("🔧 Tool Execution Results:"));
721
- logger.always(` Tool: ${chalk.cyan(toolName)}`);
722
- logger.always(` Server: ${chalk.cyan(serverName)}`);
723
- logger.always(` Result: ${JSON.stringify(executionResult, null, 2)}`);
724
- logger.always(` Timestamp: ${result.timestamp}`);
725
- }
726
- }
727
- catch (toolError) {
728
- const errorMessage = toolError instanceof Error ? toolError.message : String(toolError);
729
- if (spinner) {
730
- spinner.fail(chalk.red("❌ Tool execution failed"));
661
+ await this.getMCPStatusWithTimeout(sdk);
662
+ // Check if server exists and is connected
663
+ const allServers = await sdk.listMCPServers();
664
+ const server = allServers.find((s) => s.name === serverName);
665
+ if (!server) {
666
+ if (spinner) {
667
+ spinner.fail();
668
+ }
669
+ logger.error(chalk.red(`❌ Server not found: ${serverName}`));
670
+ exitCode = 1;
731
671
  }
732
- const result = {
733
- tool: toolName,
734
- server: serverName,
735
- params,
736
- _error: errorMessage,
737
- success: false,
738
- timestamp: new Date().toISOString(),
739
- };
740
- if (argv.format === "json") {
741
- logger.always(JSON.stringify(result, null, 2));
672
+ else if (server.status !== "connected") {
673
+ if (spinner) {
674
+ spinner.fail();
675
+ }
676
+ logger.error(chalk.red(`❌ Server not connected: ${serverName}`));
677
+ logger.always(chalk.yellow("💡 Try: neurolink mcp test " + serverName));
678
+ exitCode = 1;
742
679
  }
743
680
  else {
744
- logger.error(chalk.red("🔧 Tool Execution Failed:"));
745
- logger.error(` Tool: ${chalk.cyan(toolName)}`);
746
- logger.error(` Server: ${chalk.cyan(serverName)}`);
747
- logger.error(` Error: ${chalk.red(errorMessage)}`);
681
+ // Check if tool exists
682
+ const tool = server.tools?.find((t) => t.name === toolName);
683
+ if (!tool) {
684
+ if (spinner) {
685
+ spinner.fail();
686
+ }
687
+ logger.error(chalk.red(`❌ Tool not found: ${toolName}`));
688
+ if (server.tools?.length) {
689
+ logger.always(chalk.blue("Available tools:"));
690
+ server.tools.forEach((t) => {
691
+ logger.always(` • ${t.name}: ${t.description}`);
692
+ });
693
+ }
694
+ exitCode = 1;
695
+ }
696
+ else {
697
+ exitCode = await this.runExecTool(toolName, serverName, params, argv, spinner);
698
+ }
748
699
  }
749
- process.exit(1);
750
700
  }
701
+ finally {
702
+ // Always shut down MCP connections to prevent lingering child processes
703
+ await sdk.shutdown().catch(() => undefined);
704
+ }
705
+ // Flush stdout/stderr before exit so buffered output (spinner lines,
706
+ // result text) is not truncated by process.exit(). process.exit() is
707
+ // still required because MCP stdio connections and health-check timers
708
+ // keep the Node.js event loop alive even after sdk.shutdown().
709
+ await new Promise((resolve) => {
710
+ process.stdout.write("", () => {
711
+ process.stderr.write("", () => resolve());
712
+ });
713
+ });
714
+ process.exit(exitCode);
751
715
  }
752
716
  catch (_error) {
753
717
  logger.error(chalk.red(`❌ Exec command failed: ${_error.message}`));
754
718
  process.exit(1);
755
719
  }
756
720
  }
721
+ /**
722
+ * Run the actual MCP tool execution and format/write the output.
723
+ * Extracted to keep executeExec nesting within ESLint max-depth limit.
724
+ * Returns 0 on success, 1 on failure.
725
+ */
726
+ static async runExecTool(toolName, serverName, params, argv, spinner) {
727
+ const WARN_BYTES = 50 * 1024; // 50 KB
728
+ try {
729
+ const { toolRegistry } = await import("../../lib/mcp/toolRegistry.js");
730
+ const executionResult = await withTimeout(toolRegistry.executeTool(toolName, params, {
731
+ sessionId: `cli-${Date.now()}`,
732
+ userId: process.env.USER || "cli-user",
733
+ config: { domainType: "cli-execution", customData: { serverName } },
734
+ }), MCP_STATUS_TIMEOUT_MS, ErrorFactory.toolTimeout(toolName, MCP_STATUS_TIMEOUT_MS));
735
+ const result = {
736
+ tool: toolName,
737
+ server: serverName,
738
+ params,
739
+ result: executionResult,
740
+ success: true,
741
+ timestamp: new Date().toISOString(),
742
+ };
743
+ if (spinner) {
744
+ spinner.succeed(chalk.green("✅ Tool executed successfully"));
745
+ }
746
+ const resultJson = JSON.stringify(result, null, 2);
747
+ const resultBytes = Buffer.byteLength(resultJson, "utf-8");
748
+ const outputFile = argv.output;
749
+ if (outputFile) {
750
+ await fs.promises.writeFile(outputFile, resultJson, "utf-8");
751
+ logger.always(chalk.green(`✅ Result saved to: ${chalk.cyan(outputFile)}`));
752
+ logger.always(` Size: ${resultBytes >= 1024 ? `${(resultBytes / 1024).toFixed(1)} KB` : `${resultBytes} B`}`);
753
+ }
754
+ else if (argv.format === "json") {
755
+ if (resultBytes > WARN_BYTES) {
756
+ logger.warn(chalk.yellow(`⚠ Large result (${(resultBytes / 1024).toFixed(1)} KB). ` +
757
+ `Use --output <file> to save to disk instead.`));
758
+ }
759
+ logger.always(resultJson);
760
+ }
761
+ else {
762
+ if (resultBytes > WARN_BYTES) {
763
+ logger.warn(chalk.yellow(`⚠ Large result (${(resultBytes / 1024).toFixed(1)} KB). ` +
764
+ `Use --output <file> to save to disk instead.`));
765
+ }
766
+ logger.always(chalk.green("🔧 Tool Execution Results:"));
767
+ logger.always(` Tool: ${chalk.cyan(toolName)}`);
768
+ logger.always(` Server: ${chalk.cyan(serverName)}`);
769
+ logger.always(` Result: ${JSON.stringify(executionResult, null, 2)}`);
770
+ logger.always(` Timestamp: ${result.timestamp}`);
771
+ }
772
+ return 0;
773
+ }
774
+ catch (toolError) {
775
+ const errorMessage = toolError instanceof Error ? toolError.message : String(toolError);
776
+ if (spinner) {
777
+ spinner.fail(chalk.red("❌ Tool execution failed"));
778
+ }
779
+ const result = {
780
+ tool: toolName,
781
+ server: serverName,
782
+ params,
783
+ _error: errorMessage,
784
+ success: false,
785
+ timestamp: new Date().toISOString(),
786
+ };
787
+ if (argv.format === "json") {
788
+ logger.always(JSON.stringify(result, null, 2));
789
+ }
790
+ else {
791
+ logger.error(chalk.red("🔧 Tool Execution Failed:"));
792
+ logger.error(` Tool: ${chalk.cyan(toolName)}`);
793
+ logger.error(` Server: ${chalk.cyan(serverName)}`);
794
+ logger.error(` Error: ${chalk.red(errorMessage)}`);
795
+ }
796
+ return 1;
797
+ }
798
+ }
757
799
  /**
758
800
  * Execute remove command
759
801
  */
@@ -5,4 +5,4 @@ import type { TextGenerationOptions } from "../../lib/types/index.js";
5
5
  * This object provides metadata for validation and help text in the CLI loop.
6
6
  * It is derived from the main TextGenerationOptions interface to ensure consistency.
7
7
  */
8
- export declare const textGenerationOptionsSchema: Record<keyof Omit<TextGenerationOptions, "prompt" | "input" | "schema" | "tools" | "context" | "conversationHistory" | "conversationMessages" | "conversationMemoryConfig" | "originalPrompt" | "middleware" | "expectedOutcome" | "evaluationCriteria" | "region" | "csvOptions" | "tts" | "thinkingConfig" | "requestId" | "fileRegistry" | "abortSignal" | "toolFilter" | "excludeTools" | "toolChoice" | "prepareStep">, OptionSchema>;
8
+ export declare const textGenerationOptionsSchema: Record<keyof Omit<TextGenerationOptions, "prompt" | "input" | "schema" | "tools" | "context" | "conversationHistory" | "conversationMessages" | "conversationMemoryConfig" | "originalPrompt" | "middleware" | "expectedOutcome" | "evaluationCriteria" | "region" | "csvOptions" | "tts" | "thinkingConfig" | "requestId" | "fileRegistry" | "abortSignal" | "toolFilter" | "excludeTools" | "toolChoice" | "prepareStep" | "credentials">, OptionSchema>;
@@ -1,4 +1,4 @@
1
- import type { AIProvider, SupportedModelName } from "../types/index.js";
1
+ import type { AIProvider, SupportedModelName, NeurolinkCredentials } from "../types/index.js";
2
2
  import { AIProviderName } from "../constants/enums.js";
3
3
  import type { UnknownRecord } from "../types/common.js";
4
4
  import type { ProviderPairResult } from "../types/typeAliases.js";
@@ -27,7 +27,7 @@ export declare class AIProviderFactory {
27
27
  * @param region - Optional region override for cloud providers
28
28
  * @returns AIProvider instance
29
29
  */
30
- static createProvider(providerName: string, modelName?: string | null, enableMCP?: boolean, sdk?: UnknownRecord, region?: string): Promise<AIProvider>;
30
+ static createProvider(providerName: string, modelName?: string | null, enableMCP?: boolean, sdk?: UnknownRecord, region?: string, credentials?: NeurolinkCredentials): Promise<AIProvider>;
31
31
  /**
32
32
  * Create a provider instance with specific provider enum and model
33
33
  * @param provider - Provider enum value
@@ -167,7 +167,7 @@ export class AIProviderFactory {
167
167
  return resolvedModelName;
168
168
  }
169
169
  }
170
- static async createResolvedProvider(providerName, resolvedModelName, sdk, region, functionTag) {
170
+ static async createResolvedProvider(providerName, resolvedModelName, sdk, region, functionTag, credentials) {
171
171
  await withTimeout(ProviderRegistry.registerAllProviders(), 30_000, ErrorFactory.toolTimeout("provider-registration", 30_000));
172
172
  const normalizedName = this.normalizeProviderName(providerName);
173
173
  const finalModelName = resolvedModelName === "default" || resolvedModelName === null
@@ -179,7 +179,7 @@ export class AIProviderFactory {
179
179
  resolvedModelName: resolvedModelName || "not resolved",
180
180
  finalModelName: finalModelName || "using provider default",
181
181
  });
182
- const provider = await withTimeout(ProviderFactory.createProvider(normalizedName, finalModelName, sdk, region), 30_000, ErrorFactory.toolTimeout(`provider-creation:${normalizedName}`, 30_000));
182
+ const provider = await withTimeout(ProviderFactory.createProvider(normalizedName, finalModelName, sdk, region, credentials), 30_000, ErrorFactory.toolTimeout(`provider-creation:${normalizedName}`, 30_000));
183
183
  return { normalizedName, finalModelName, provider };
184
184
  }
185
185
  /**
@@ -191,7 +191,7 @@ export class AIProviderFactory {
191
191
  * @param region - Optional region override for cloud providers
192
192
  * @returns AIProvider instance
193
193
  */
194
- static async createProvider(providerName, modelName, enableMCP = true, sdk, region) {
194
+ static async createProvider(providerName, modelName, enableMCP = true, sdk, region, credentials) {
195
195
  const functionTag = "AIProviderFactory.createProvider";
196
196
  // Providers are registered via ProviderFactory.initialize() on first use
197
197
  return factoryTracer.startActiveSpan("neurolink.factory.createProvider", {
@@ -225,7 +225,7 @@ export class AIProviderFactory {
225
225
  // The dynamic model provider now provides reliable functionality without hanging
226
226
  let resolvedModelName = this.resolveModelFromEnvironment(providerName, modelName, functionTag);
227
227
  resolvedModelName = await this.resolveDynamicModelName(providerName, modelName, resolvedModelName, functionTag);
228
- const { normalizedName, finalModelName, provider } = await this.createResolvedProvider(providerName, resolvedModelName, sdk, region, functionTag);
228
+ const { normalizedName, finalModelName, provider } = await this.createResolvedProvider(providerName, resolvedModelName, sdk, region, functionTag, credentials);
229
229
  // Summary logging in format expected by debugging tools
230
230
  logger.debug(`[AIProviderFactory] Provider creation completed { providerName: '${normalizedName}', modelName: '${finalModelName}' }`);
231
231
  logger.debug(`[AIProviderFactory] Resolved model: ${finalModelName}`);
@@ -7,6 +7,7 @@ import { tracers } from "../telemetry/tracers.js";
7
7
  import { randomUUID } from "crypto";
8
8
  import { MESSAGES_PER_TURN } from "../config/conversationMemory.js";
9
9
  import { generateToolOutputPreview } from "../context/toolOutputLimits.js";
10
+ import { NEUROLINK_ARTIFACT_ID_KEY } from "../mcp/mcpOutputNormalizer.js";
10
11
  import { SummarizationEngine } from "../context/summarizationEngine.js";
11
12
  import { NeuroLink } from "../neurolink.js";
12
13
  import { ConversationMemoryError } from "../types/conversation.js";
@@ -1320,11 +1321,30 @@ User message: "${userMessage}"`;
1320
1321
  maxBytes: this.config?.contextCompaction?.maxToolOutputBytes,
1321
1322
  maxLines: this.config?.contextCompaction?.maxToolOutputLines,
1322
1323
  });
1324
+ // Extract artifact ID if this result was externalized by McpOutputNormalizer.
1325
+ // The surrogate carries `_meta.neurolinkArtifactId` on the raw result object.
1326
+ let artifactId;
1327
+ try {
1328
+ const rawResult = toolResult.result;
1329
+ if (rawResult && typeof rawResult === "object") {
1330
+ const meta = rawResult._meta;
1331
+ if (meta && typeof meta === "object") {
1332
+ const idValue = meta[NEUROLINK_ARTIFACT_ID_KEY];
1333
+ if (typeof idValue === "string") {
1334
+ artifactId = idValue;
1335
+ }
1336
+ }
1337
+ }
1338
+ }
1339
+ catch {
1340
+ // Ignore extraction errors — artifact ID is best-effort metadata
1341
+ }
1323
1342
  // Build metadata — only store preview when truncation occurred (no duplication)
1324
1343
  const metadata = {
1325
1344
  truncated,
1326
1345
  ...(truncated && { toolOutputPreview: preview }),
1327
1346
  ...(truncated && { originalSize }),
1347
+ ...(artifactId && { artifactId }),
1328
1348
  };
1329
1349
  // Build result — success/error metadata only, NOT the output data
1330
1350
  const result = {
@@ -1,6 +1,6 @@
1
1
  import type { AIProviderName } from "../constants/enums.js";
2
2
  import type { UnknownRecord } from "../types/common.js";
3
- import type { AIProvider } from "../types/index.js";
3
+ import type { AIProvider, NeurolinkCredentials } from "../types/index.js";
4
4
  /**
5
5
  * Provider constructor interface - supports both sync constructors and async factory functions
6
6
  */
@@ -33,7 +33,7 @@ export declare class ProviderFactory {
33
33
  * @param providerName - Provider name (optional, uses NEUROLINK_PROVIDER env var or 'vertex' as default)
34
34
  * @param modelName - Model name (optional, uses provider-specific env var or registry default)
35
35
  */
36
- static createProvider(providerName?: AIProviderName | string, modelName?: string, sdk?: UnknownRecord, region?: string): Promise<AIProvider>;
36
+ static createProvider(providerName?: AIProviderName | string, modelName?: string, sdk?: UnknownRecord, region?: string, credentials?: NeurolinkCredentials): Promise<AIProvider>;
37
37
  /**
38
38
  * Check if a provider is registered
39
39
  */
@@ -67,10 +67,10 @@ export declare class ProviderFactory {
67
67
  * Create the best available provider for the given name
68
68
  * Used by NeuroLink SDK for streaming and generation
69
69
  */
70
- static createBestProvider(providerName: AIProviderName | string, modelName?: string, enableMCP?: boolean, sdk?: UnknownRecord): Promise<AIProvider>;
70
+ static createBestProvider(providerName: AIProviderName | string, modelName?: string, enableMCP?: boolean, sdk?: UnknownRecord, credentials?: NeurolinkCredentials): Promise<AIProvider>;
71
71
  }
72
72
  /**
73
73
  * Helper function to create providers with backward compatibility
74
74
  */
75
- export declare function createAIProvider(providerName: AIProviderName | string, modelName?: string): Promise<AIProvider>;
75
+ export declare function createAIProvider(providerName: AIProviderName | string, modelName?: string, credentials?: NeurolinkCredentials): Promise<AIProvider>;
76
76
  export {};
@@ -30,7 +30,7 @@ export class ProviderFactory {
30
30
  * @param providerName - Provider name (optional, uses NEUROLINK_PROVIDER env var or 'vertex' as default)
31
31
  * @param modelName - Model name (optional, uses provider-specific env var or registry default)
32
32
  */
33
- static async createProvider(providerName, modelName, sdk, region) {
33
+ static async createProvider(providerName, modelName, sdk, region, credentials) {
34
34
  // Note: Providers are registered explicitly by ProviderRegistry to avoid circular dependencies
35
35
  // Use environment variable or default if not specified
36
36
  const resolvedProviderName = providerName ||
@@ -56,13 +56,26 @@ export class ProviderFactory {
56
56
  // Fallback to registry default if no env var
57
57
  model = model || registration.defaultModel;
58
58
  }
59
+ // Map registered provider names to NeurolinkCredentials keys.
60
+ // Most names match (openai, anthropic, vertex, bedrock, etc.)
61
+ // but some differ (google-ai → googleAiStudio, openai-compatible → openaiCompatible).
62
+ const credentialKeyMap = {
63
+ "google-ai": "googleAiStudio",
64
+ "openai-compatible": "openaiCompatible",
65
+ huggingface: "huggingFace",
66
+ };
67
+ const credKey = credentialKeyMap[normalizedName] ?? normalizedName;
68
+ // Extract provider-scoped credential slice (e.g. credentials.openai for OpenAI)
69
+ const scopedCredentials = credentials
70
+ ? credentials[credKey]
71
+ : undefined;
59
72
  try {
60
73
  if (typeof registration.constructor !== "function") {
61
74
  throw new Error(`Invalid constructor for provider ${providerName}: not a function`);
62
75
  }
63
76
  let result;
64
77
  try {
65
- const factoryResult = registration.constructor(model, resolvedProviderName, sdk, region);
78
+ const factoryResult = registration.constructor(model, resolvedProviderName, sdk, region, scopedCredentials);
66
79
  // Handle both sync and async results
67
80
  result =
68
81
  factoryResult instanceof Promise
@@ -74,7 +87,7 @@ export class ProviderFactory {
74
87
  registration.constructor.prototype.constructor ===
75
88
  registration.constructor) {
76
89
  try {
77
- result = new registration.constructor(model, resolvedProviderName, sdk, region);
90
+ result = new registration.constructor(model, resolvedProviderName, sdk, region, scopedCredentials);
78
91
  }
79
92
  catch (constructorError) {
80
93
  throw new Error(`Both factory function and constructor failed. Factory error: ${factoryError}. Constructor error: ${constructorError}`, { cause: constructorError });
@@ -154,13 +167,13 @@ export class ProviderFactory {
154
167
  * Create the best available provider for the given name
155
168
  * Used by NeuroLink SDK for streaming and generation
156
169
  */
157
- static async createBestProvider(providerName, modelName, enableMCP, sdk) {
158
- return await ProviderFactory.createProvider(providerName, modelName, sdk);
170
+ static async createBestProvider(providerName, modelName, enableMCP, sdk, credentials) {
171
+ return await ProviderFactory.createProvider(providerName, modelName, sdk, undefined, credentials);
159
172
  }
160
173
  }
161
174
  /**
162
175
  * Helper function to create providers with backward compatibility
163
176
  */
164
- export async function createAIProvider(providerName, modelName) {
165
- return await ProviderFactory.createProvider(providerName, modelName);
177
+ export async function createAIProvider(providerName, modelName, credentials) {
178
+ return await ProviderFactory.createProvider(providerName, modelName, undefined, undefined, credentials);
166
179
  }
@@ -13,6 +13,11 @@ export declare class ProviderRegistry {
13
13
  static registerAllProviders(): Promise<void>;
14
14
  /**
15
15
  * Internal registration implementation
16
+ *
17
+ * This method is a flat list of 13 provider registrations. Each registration
18
+ * is self-contained and extracting helpers would add indirection without
19
+ * reducing complexity — the function is long because there are many providers,
20
+ * not because any single registration is complex.
16
21
  */
17
22
  private static _doRegister;
18
23
  /**
@@ -32,82 +32,101 @@ export class ProviderRegistry {
32
32
  }
33
33
  /**
34
34
  * Internal registration implementation
35
+ *
36
+ * This method is a flat list of 13 provider registrations. Each registration
37
+ * is self-contained and extracting helpers would add indirection without
38
+ * reducing complexity — the function is long because there are many providers,
39
+ * not because any single registration is complex.
35
40
  */
41
+ // eslint-disable-next-line max-lines-per-function
36
42
  static async _doRegister() {
37
43
  try {
38
44
  // Register providers with dynamic import factory functions
39
45
  const { ProviderFactory } = await import("./providerFactory.js");
40
46
  // Register Google AI Studio Provider (our validated baseline)
41
- ProviderFactory.registerProvider(AIProviderName.GOOGLE_AI, async (modelName, _providerName, sdk) => {
47
+ ProviderFactory.registerProvider(AIProviderName.GOOGLE_AI, async (modelName, _providerName, sdk, _region, credentials) => {
48
+ const googleAiCreds = credentials;
42
49
  const { GoogleAIStudioProvider } = await import("../providers/googleAiStudio.js");
43
- return new GoogleAIStudioProvider(modelName, sdk);
50
+ return new GoogleAIStudioProvider(modelName, sdk, googleAiCreds);
44
51
  }, GoogleAIModels.GEMINI_2_5_FLASH, ["googleAiStudio", "google", "gemini", "google-ai", "google-ai-studio"]);
45
52
  // Register OpenAI provider
46
- ProviderFactory.registerProvider(AIProviderName.OPENAI, async (modelName, _providerName, sdk) => {
53
+ ProviderFactory.registerProvider(AIProviderName.OPENAI, async (modelName, _providerName, sdk, _region, credentials) => {
54
+ const openaiCreds = credentials;
47
55
  const { OpenAIProvider } = await import("../providers/openAI.js");
48
- return new OpenAIProvider(modelName, sdk);
56
+ return new OpenAIProvider(modelName, sdk, undefined, openaiCreds);
49
57
  }, OpenAIModels.GPT_4O_MINI, ["gpt", "chatgpt"]);
50
58
  // Register Anthropic provider
51
- ProviderFactory.registerProvider(AIProviderName.ANTHROPIC, async (modelName, _providerName, sdk) => {
59
+ ProviderFactory.registerProvider(AIProviderName.ANTHROPIC, async (modelName, _providerName, sdk, _region, credentials) => {
60
+ const anthropicCreds = credentials;
52
61
  const { AnthropicProvider } = await import("../providers/anthropic.js");
53
- return new AnthropicProvider(modelName, sdk);
62
+ return new AnthropicProvider(modelName, sdk, undefined, anthropicCreds);
54
63
  }, AnthropicModels.CLAUDE_SONNET_4_6, ["claude", "anthropic"]);
55
64
  // Register Amazon Bedrock provider
56
- ProviderFactory.registerProvider(AIProviderName.BEDROCK, async (modelName, _providerName, sdk, region) => {
65
+ ProviderFactory.registerProvider(AIProviderName.BEDROCK, async (modelName, _providerName, sdk, region, credentials) => {
66
+ const bedrockCreds = credentials;
57
67
  const { AmazonBedrockProvider } = await import("../providers/amazonBedrock.js");
58
- return new AmazonBedrockProvider(modelName, sdk, region);
68
+ return new AmazonBedrockProvider(modelName, sdk, region, bedrockCreds);
59
69
  }, undefined, // Let provider read BEDROCK_MODEL from .env
60
70
  ["bedrock", "aws"]);
61
71
  // Register Azure OpenAI provider
62
- ProviderFactory.registerProvider(AIProviderName.AZURE, async (modelName, _providerName, sdk) => {
72
+ ProviderFactory.registerProvider(AIProviderName.AZURE, async (modelName, _providerName, sdk, _region, credentials) => {
73
+ const azureCreds = credentials;
63
74
  const { AzureOpenAIProvider } = await import("../providers/azureOpenai.js");
64
- return new AzureOpenAIProvider(modelName, sdk);
75
+ return new AzureOpenAIProvider(modelName, sdk, undefined, azureCreds);
65
76
  }, process.env.AZURE_MODEL ||
66
77
  process.env.AZURE_OPENAI_MODEL ||
67
78
  process.env.AZURE_OPENAI_DEPLOYMENT ||
68
79
  process.env.AZURE_OPENAI_DEPLOYMENT_ID ||
69
80
  "gpt-4o-mini", ["azure", "azureOpenai"]);
70
81
  // Register Google Vertex AI provider
71
- ProviderFactory.registerProvider(AIProviderName.VERTEX, async (modelName, providerName, sdk, region) => {
82
+ ProviderFactory.registerProvider(AIProviderName.VERTEX, async (modelName, providerName, sdk, region, credentials) => {
83
+ const vertexCreds = credentials;
72
84
  const { GoogleVertexProvider } = await import("../providers/googleVertex.js");
73
- return new GoogleVertexProvider(modelName, providerName, sdk, region);
85
+ return new GoogleVertexProvider(modelName, providerName, sdk, region, vertexCreds);
74
86
  }, VertexModels.CLAUDE_4_6_SONNET, ["vertex", "googleVertex"]);
75
87
  // Register Hugging Face provider (Unified Router implementation)
76
- ProviderFactory.registerProvider(AIProviderName.HUGGINGFACE, async (modelName) => {
88
+ ProviderFactory.registerProvider(AIProviderName.HUGGINGFACE, async (modelName, _providerName, _sdk, _region, credentials) => {
89
+ const hfCreds = credentials;
77
90
  const { HuggingFaceProvider } = await import("../providers/huggingFace.js");
78
- return new HuggingFaceProvider(modelName);
91
+ return new HuggingFaceProvider(modelName, undefined, hfCreds);
79
92
  }, process.env.HUGGINGFACE_MODEL ||
80
93
  HuggingFaceModels.QWEN_2_5_72B_INSTRUCT, ["huggingface", "hf"]);
81
94
  // Register Mistral AI provider
82
- ProviderFactory.registerProvider(AIProviderName.MISTRAL, async (modelName, _providerName, sdk) => {
95
+ ProviderFactory.registerProvider(AIProviderName.MISTRAL, async (modelName, _providerName, sdk, _region, credentials) => {
96
+ const mistralCreds = credentials;
83
97
  const { MistralProvider } = await import("../providers/mistral.js");
84
- return new MistralProvider(modelName, sdk);
98
+ return new MistralProvider(modelName, sdk, undefined, mistralCreds);
85
99
  }, MistralModels.MISTRAL_LARGE_LATEST, ["mistral"]);
86
100
  // Register Ollama provider
87
- ProviderFactory.registerProvider(AIProviderName.OLLAMA, async (modelName) => {
101
+ ProviderFactory.registerProvider(AIProviderName.OLLAMA, async (modelName, _providerName, _sdk, _region, credentials) => {
102
+ const ollamaCreds = credentials;
88
103
  const { OllamaProvider } = await import("../providers/ollama.js");
89
- return new OllamaProvider(modelName);
104
+ return new OllamaProvider(modelName, ollamaCreds);
90
105
  }, process.env.OLLAMA_MODEL || OllamaModels.LLAMA3_2_LATEST, ["ollama", "local"]);
91
106
  // Register LiteLLM provider
92
- ProviderFactory.registerProvider(AIProviderName.LITELLM, async (modelName, _providerName, sdk) => {
107
+ ProviderFactory.registerProvider(AIProviderName.LITELLM, async (modelName, _providerName, sdk, _region, credentials) => {
108
+ const litellmCreds = credentials;
93
109
  const { LiteLLMProvider } = await import("../providers/litellm.js");
94
- return new LiteLLMProvider(modelName, sdk);
110
+ return new LiteLLMProvider(modelName, sdk, undefined, litellmCreds);
95
111
  }, process.env.LITELLM_MODEL || LiteLLMModels.OPENAI_GPT_4O_MINI, ["litellm"]);
96
112
  // Register OpenAI Compatible provider
97
- ProviderFactory.registerProvider(AIProviderName.OPENAI_COMPATIBLE, async (modelName, _providerName, sdk) => {
113
+ ProviderFactory.registerProvider(AIProviderName.OPENAI_COMPATIBLE, async (modelName, _providerName, sdk, _region, credentials) => {
114
+ const openaiCompatCreds = credentials;
98
115
  const { OpenAICompatibleProvider } = await import("../providers/openaiCompatible.js");
99
- return new OpenAICompatibleProvider(modelName, sdk);
116
+ return new OpenAICompatibleProvider(modelName, sdk, undefined, openaiCompatCreds);
100
117
  }, process.env.OPENAI_COMPATIBLE_MODEL || undefined, // Enable auto-discovery when no model specified
101
118
  ["openai-compatible", "vllm", "compatible"]);
102
119
  // Register OpenRouter provider (300+ models from 60+ providers)
103
- ProviderFactory.registerProvider(AIProviderName.OPENROUTER, async (modelName, _providerName, sdk) => {
120
+ ProviderFactory.registerProvider(AIProviderName.OPENROUTER, async (modelName, _providerName, sdk, _region, credentials) => {
121
+ const openrouterCreds = credentials;
104
122
  const { OpenRouterProvider } = await import("../providers/openRouter.js");
105
- return new OpenRouterProvider(modelName, sdk);
123
+ return new OpenRouterProvider(modelName, sdk, undefined, openrouterCreds);
106
124
  }, process.env.OPENROUTER_MODEL || "anthropic/claude-3-5-sonnet", ["openrouter", "or"]);
107
125
  // Register Amazon SageMaker provider
108
- ProviderFactory.registerProvider(AIProviderName.SAGEMAKER, async (modelName, _providerName, _sdk, region) => {
126
+ ProviderFactory.registerProvider(AIProviderName.SAGEMAKER, async (modelName, _providerName, _sdk, region, credentials) => {
127
+ const sagemakerCreds = credentials;
109
128
  const { AmazonSageMakerProvider } = await import("../providers/amazonSagemaker.js");
110
- return new AmazonSageMakerProvider(modelName, undefined, region);
129
+ return new AmazonSageMakerProvider(modelName, undefined, region, undefined, sagemakerCreds);
111
130
  }, process.env.SAGEMAKER_MODEL || "sagemaker-model", ["sagemaker", "aws-sagemaker"]);
112
131
  logger.debug("All providers registered successfully");
113
132
  this.registered = true;
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Artifact Store
3
+ *
4
+ * Pluggable storage for externalized MCP tool outputs.
5
+ *
6
+ * When `mcp.outputLimits.strategy = "externalize"` the full tool payload is
7
+ * written here instead of being sent inline to the LLM. The model receives a
8
+ * compact surrogate with a preview and an artifact ID. The full payload can be
9
+ * retrieved on demand via the `retrieve_context` tool.
10
+ *
11
+ * Architecture:
12
+ * ArtifactStore (interface) — canonical types in src/lib/types/artifactTypes.ts
13
+ * LocalTempArtifactStore — single-process, filesystem-backed implementation
14
+ *
15
+ * Distributed backends (S3, Redis blobs) can be added later by implementing
16
+ * ArtifactStore from types/artifactTypes.ts.
17
+ *
18
+ * @module artifacts/artifactStore
19
+ */
20
+ import type { ArtifactMeta, ArtifactRef, ArtifactStore } from "../types/artifactTypes.js";
21
+ export type { ArtifactMeta, ArtifactRef, ArtifactStore, } from "../types/artifactTypes.js";
22
+ /**
23
+ * Filesystem-backed artifact store using the OS temp directory.
24
+ *
25
+ * Files are written with mode 0o600 (owner read/write only).
26
+ * An in-memory index tracks metadata without a separate index file.
27
+ *
28
+ * Suitable for:
29
+ * - CLI usage
30
+ * - Single-process SDK deployments
31
+ * - Multi-process deployments where each process manages its own artifacts
32
+ * (artifacts created in one process are not visible to others)
33
+ *
34
+ * @example
35
+ * ```typescript
36
+ * const store = new LocalTempArtifactStore();
37
+ * const ref = await store.store(largeJson, {
38
+ * toolName: "list_files",
39
+ * serverId: "filesystem-server",
40
+ * sizeBytes: Buffer.byteLength(largeJson),
41
+ * contentType: "json",
42
+ * });
43
+ * // Later, via retrieve_context:
44
+ * const full = await store.retrieve(ref.id);
45
+ * ```
46
+ */
47
+ export declare class LocalTempArtifactStore implements ArtifactStore {
48
+ private readonly dir;
49
+ private readonly index;
50
+ constructor(dir?: string);
51
+ generatePreview(payload: string): string;
52
+ store(payload: string, meta: Omit<ArtifactMeta, "createdAt">): Promise<ArtifactRef>;
53
+ retrieve(id: string): Promise<string | null>;
54
+ delete(id: string): Promise<void>;
55
+ cleanup(olderThanMs: number): Promise<number>;
56
+ }