🚨 NeuroLink Troubleshooting Guide

✅ IMPLEMENTATION STATUS: COMPLETE (2025-01-07)

Generate Function Migration completed - Updated troubleshooting for new primary method

✅ Added troubleshooting for generate() function
✅ Migration guidance for common issues
✅ Legacy generate() troubleshooting preserved
✅ Factory pattern error handling documented

Migration Note: Most issues apply to both the new generate() API (options-based) and the legacy generate() API. Use the new generate() examples for troubleshooting unless you are on the legacy API.

Version: v1.7.1 Last Updated: January 7, 2025

📖 Overview

This guide helps diagnose and resolve common issues with NeuroLink, including AI provider connectivity, MCP integration, CLI usage problems, and the new generate function migration.

🎯 Generate Function Migration Issues

Migration Questions

Q: Should I update my existing code to use the new generate() API? A: Optional. Your existing legacy generate() code continues working unchanged. Prefer the new generate() API for new projects.

Q: What's the difference between the new generate() and the legacy generate()? A: The new generate() has a more extensible interface for future multi‑modal features. Both produce identical results for text generation today.

Q: I see deprecation warnings with the legacy generate() A: These are informational only. The legacy API remains supported. To remove warnings, migrate to the new generate() API.

Migration Examples

// ✅ NEW: Recommended usage
const result = await neurolink.generate({
  input: { text: "Your prompt" },
  provider: "google-ai",
});

// 📜 LEGACY: Still fully supported
const result = await neurolink.generate({
  prompt: "Your prompt",
  provider: "google-ai",
});

CLI Migration

# ✅ NEW: Options-based API
npx @juspay/neurolink generate --prompt "Your prompt" --provider openai

# 📜 LEGACY: Positional arguments (still works, shows deprecation warning)
npx @juspay/neurolink generate "Your prompt" --provider openai

🔧 MCP Integration Issues

✅ Built-in Tools Not Working

Status: ✅ RESOLVED in v1.7.1

Previous Issue: Time tool and other built-in tools were not loading due to circular dependencies.

Solution Applied:

# Fixed in v1.7.1 - built-in tools now work
node dist/cli/index.js generate "What time is it?" --debug
# Should return: "The current time is [current date and time]"

If still having issues:

🏗️ Configuration Management Issues (NEW v3.0)

Config Update Failures

Symptoms: Config updates fail with validation errors or backup issues

Solutions:

# Check config validation
npx @juspay/neurolink config validate

# Check backup system
ls -la .neurolink.backups/

# Manual backup creation
npx @juspay/neurolink config backup --reason "manual-backup"

# Restore from backup
npx @juspay/neurolink config restore --backup latest

Backup System Issues

Symptoms: Backups not created or corrupted

Solutions:

# Verify backup directory permissions
ls -la .neurolink.backups/

# Check backup integrity
npx @juspay/neurolink config verify-backups

# Cleanup corrupted backups
npx @juspay/neurolink config cleanup --verify

# Reset backup system
rm -rf .neurolink.backups/
mkdir .neurolink.backups/

Provider Configuration Issues

Symptoms: Providers not loading or failing validation

Solutions:

# Test individual provider
npx @juspay/neurolink test-provider google

# Check provider status
npx @juspay/neurolink status

# Reset provider configuration
npx @juspay/neurolink config reset-provider google

# Validate environment variables
npx @juspay/neurolink env check

🔧 TypeScript Compilation Issues (NEW v3.0)

Build Failures

Symptoms: pnpm run build:cli fails with TypeScript errors

Common Errors & Solutions:

// ERROR: Argument of type 'unknown' is not assignable to parameter of type 'string'
// SOLUTION: Use type casting
const value = String(unknownValue || "default");

// ERROR: Property 'success' does not exist on type 'unknown'
// SOLUTION: Cast to expected type
const result = response as ToolResult;
if (result.success) {
  /* ... */
}

// ERROR: Interface compatibility issues
// SOLUTION: Use optional methods
if (registry.executeTool) {
  const result = await registry.executeTool("tool", args, context);
}

Build Validation:

# Check TypeScript compilation
npx tsc --noEmit --project tsconfig.cli.json

# Full CLI build
pnpm run build:cli

# Check for type errors
npx tsc --listFiles --project tsconfig.cli.json

Interface Compatibility Issues

Symptoms: Type errors when using new interfaces

Solutions:

// Use optional chaining for new methods
registry.registerServer?.("server", config, context);

// Type casting for unknown returns
const result = (await registry.executeTool("tool", args)) as ToolResult;

// Handle both legacy and new interfaces
if ("registerServer" in registry) {
  await registry.registerServer("server", config, context);
} else {
  registry.register_server("server", config);
}

⚡ Performance Issues (NEW v3.0)

Slow Tool Execution

Symptoms: Tool execution taking longer than expected (>1ms target)

Solutions:

# Enable performance monitoring
NEUROLINK_PERFORMANCE_MONITORING=true

# Check execution statistics
npx @juspay/neurolink stats

# Optimize cache settings
NEUROLINK_CACHE_ENABLED=true
NEUROLINK_CACHE_TTL=300

# Reduce timeout for faster failures
NEUROLINK_DEFAULT_TIMEOUT=10000

Pipeline Performance

Symptoms: Sequential pipeline execution slower than ~22ms target

Solutions:

// Use parallel execution where possible
const results = await Promise.all([
  registry.executeTool("tool1", args1, context),
  registry.executeTool("tool2", args2, context),
]);

// Enable caching for repeated operations
const context: ExecutionContext = {
  cacheOptions: {
    enabled: true,
    ttl: 300,
    key: "operation-cache",
  },
};

// Use fallback options for reliability
const context: ExecutionContext = {
  fallbackOptions: {
    enabled: true,
    maxRetries: 2,
    providers: ["openai", "anthropic"],
  },
};

🔄 Interface Migration Issues (NEW v3.0)

Property Name Errors

Symptoms: Property 'session_id' does not exist type errors

Solutions:

// OLD (snake_case) - causes errors
const context = {
  session_id: "session123",
  user_id: "user456",
  ai_provider: "google",
};

// NEW (camelCase) - correct
const context: ExecutionContext = {
  sessionId: "session123",
  userId: "user456",
  aiProvider: "google",
};

Method Call Issues

Symptoms: Cannot call undefined method runtime errors

Solutions:

// WRONG: Direct call may fail
registry.executeTool("tool", args);

// CORRECT: Use optional chaining
registry.executeTool?.("tool", args, context);

// ALTERNATIVE: Check method exists
if (registry.executeTool) {
  const result = await registry.executeTool("tool", args, context);
}

Generic Type Issues

Symptoms: Type 'unknown' is not assignable errors

Solutions:

// WRONG: Unknown return type
const result = await registry.executeTool("tool", args);

// CORRECT: Use generics
const result = await registry.executeTool<MyResultType>("tool", args, context);

// ALTERNATIVE: Type assertion
const result = (await registry.executeTool("tool", args)) as MyResultType;

🛡️ Error Recovery (NEW v3.0)

Automatic Recovery

Config Auto-Restore:

# Check if auto-restore triggered
grep "Config restored" ~/.neurolink/logs/config.log

# Verify restored config
npx @juspay/neurolink config validate

# Manual recovery if needed
npx @juspay/neurolink config restore --backup latest

Provider Fallback:

// Configure automatic fallback
const context: ExecutionContext = {
  fallbackOptions: {
    enabled: true,
    providers: ["google-ai", "openai", "anthropic"],
    maxRetries: 3,
    retryDelay: 1000,
  },
};

Manual Recovery

Reset to Defaults:

# Reset all configuration
npx @juspay/neurolink config reset --confirm

# Reset specific provider
npx @juspay/neurolink config reset-provider google

# Restore from specific backup
npx @juspay/neurolink config restore --backup neurolink-config-2025-01-07T10-30-00.js

If still having issues:

Ensure you're using v1.7.1 or later: npm list @juspay/neurolink
Clear node modules and reinstall: rm -rf node_modules && npm install
Rebuild the project: npm run build

🔍 External MCP Server Discovery Issues

Symptom: No external MCP servers found during discovery

Diagnosis:

# Check if discovery is working
npx @juspay/neurolink mcp discover --format table
# Should show 58+ discovered servers

# Check discovery with debug info
npx @juspay/neurolink mcp discover --format json | jq '.servers | length'
# Should return a number > 50

Solutions:

No Servers Found:

# Check if you have AI tools installed (VS Code, Claude, Cursor, etc.)
ls -la ~/Library/Application\ Support/Claude/
ls -la ~/.config/Code/User/
ls -la ~/.cursor/

Partial Discovery:

# Check for configuration file issues
npx @juspay/neurolink mcp discover --format json > discovery.json
# Review discovery.json for parsing errors

Discovery Errors:

# Enable debug mode
export NEUROLINK_DEBUG=true
npx @juspay/neurolink mcp discover --format table

🔧 External MCP Server Activation Issues

Status: 🔧 In Development - External servers are discovered but not yet activated

Current Behavior: Servers show as discovered but cannot be executed directly

Expected in Next Version (v1.8.0):

# Coming Soon: Direct tool execution
npx @juspay/neurolink mcp exec filesystem read_file --params '{"path": "../index.md"}'

Current Workaround: Use built-in tools while external activation is developed

🤖 AI Provider Issues

Provider Authentication Errors

Symptom: "Authentication failed" or "Invalid API key" errors

Diagnosis:

# Check provider status
npx @juspay/neurolink status --verbose

Solutions:

OpenAI Issues:

# Set API key
export OPENAI_API_KEY="sk-your-openai-api-key"

# Test connection
npx @juspay/neurolink generate "Hello" --provider openai

Google AI Studio Issues:

# Set API key (recommended for free tier)
export GOOGLE_AI_API_KEY="AIza-your-google-ai-api-key"

# Test connection
npx @juspay/neurolink generate "Hello" --provider google-ai

Google Vertex AI Issues:

# Complete Vertex AI setup
export GOOGLE_VERTEX_PROJECT="your-project-id"
export GOOGLE_VERTEX_LOCATION="us-east5"
export GOOGLE_AUTH_CLIENT_EMAIL="service-account@project.iam.gserviceaccount.com"
export GOOGLE_AUTH_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"

# Test Claude Sonnet 4 (recommended model)
npx @juspay/neurolink generate "test" --provider vertex --model claude-sonnet-4@20250514

Common Vertex AI Issues:

"Not configured" despite valid credentials: Use GOOGLE_VERTEX_PROJECT instead of GOOGLE_CLOUD_PROJECT_ID
Authentication failed: Ensure both GOOGLE_AUTH_CLIENT_EMAIL and GOOGLE_AUTH_PRIVATE_KEY are set
Model not found: Use claude-sonnet-4@20250514 format for Anthropic models via Vertex AI

Debugging Commands:

# Check provider status
npx @juspay/neurolink status

# Test basic connectivity
npx @juspay/neurolink generate "hello" --provider vertex --model claude-sonnet-4@20250514

# Debug with verbose output
npx @juspay/neurolink generate "test" --provider vertex --debug

Multiple Provider Setup:

# Create .env file
cat > .env << EOF
OPENAI_API_KEY=sk-your-openai-key
GOOGLE_AI_API_KEY=AIza-your-google-key
ANTHROPIC_API_KEY=sk-ant-your-anthropic-key
EOF

# Test auto-selection
npx @juspay/neurolink generate "Hello"

Provider Selection Issues

Symptom: Wrong provider selected or fallback not working

Diagnosis:

# Check available providers
npx @juspay/neurolink status

# Test specific provider
npx @juspay/neurolink generate "Hello" --provider google-ai --debug

Solutions:

Force Specific Provider:

npx @juspay/neurolink generate "Hello" --provider openai

Check Fallback Logic:

# This should automatically select best available provider
npx @juspay/neurolink generate "Hello" --debug

🖥️ CLI Issues

Command Not Found

Symptom: neurolink: command not found

Solutions:

Using NPX (Recommended):
```
npx @juspay/neurolink --help
```

Global Installation:

npm install -g @juspay/neurolink
neurolink --help

Local Project Usage:

npm install @juspay/neurolink
npx @juspay/neurolink --help

Build Issues

Symptom: CLI commands failing or TypeScript errors

Diagnosis:

# Check build status
npm run build

# Check for TypeScript errors
npx tsc --noEmit

Solutions:

Model Parameter Not Working

Symptom: CLI --model parameter is ignored, always uses default model

Example Issue:

# Command specifies model but output shows default model being used
node dist/cli/index.js generate "test" --provider google-ai --model gemini-2.5-flash
# Output shows: modelName: 'gemini-2.5-pro' (default instead of specified)

Status: ✅ FIXED in latest version

Solution: Update to latest version where model parameter fix has been applied.

Verification:

# Test that model parameter works correctly
node dist/cli/index.js generate "what is deepest you can think?" --provider google-ai --model gemini-2.5-flash --debug
# Should show: modelName: 'gemini-2.5-flash' in debug output

Available Models for Google AI:

gemini-2.5-flash - Fast, efficient responses
gemini-2.5-pro - Comprehensive, detailed responses

Build Issue Solutions:

Clean Build:

rm -rf dist node_modules
npm install
npm run build

Dependencies Issues:

# Update dependencies
npm update
npm run build

🧪 Testing and Validation

Comprehensive System Test

Run this test suite to validate everything is working:

# 1. Build the system
npm run build

# 2. Test built-in tools
echo "Testing built-in tools..."
node dist/cli/index.js generate "What time is it?" --debug

# 3. Test tool discovery
echo "Testing tool discovery..."
node dist/cli/index.js generate "What tools do you have access to?" --debug

# 4. Test external server discovery
echo "Testing external server discovery..."
npx @juspay/neurolink mcp discover --format table

# 5. Test AI provider
echo "Testing AI provider..."
npx @juspay/neurolink status --verbose

# 6. Run comprehensive tests
echo "Running comprehensive tests..."
npm run test:run -- test/mcp-comprehensive.test.ts

Expected Results:

✅ Build: Successful compilation
✅ Built-in tools: Time tool returns current time
✅ Tool discovery: Lists 5+ built-in tools
✅ External discovery: Shows 58+ discovered servers
✅ AI provider: At least one provider available
✅ Tests: All MCP foundation tests pass

Debug Mode

Enable detailed logging for troubleshooting:

# Enable debug mode
export NEUROLINK_DEBUG=true

# Run commands with debug output
npx @juspay/neurolink generate "Hello" --debug
npx @juspay/neurolink mcp discover --format table
npx @juspay/neurolink status --verbose

📊 System Requirements

Minimum Requirements

Node.js: v18+ (recommended: v20+)
NPM: v8+
TypeScript: v5+ (for development)
Operating System: macOS, Linux, Windows

Recommended Setup

# Check versions
node --version    # Should be v18+
npm --version     # Should be v8+

# For development
npx tsc --version # Should be v5+

🆘 Getting Help

Quick Diagnostics

# System status
npx @juspay/neurolink status --verbose

# MCP status
npx @juspay/neurolink mcp discover --format table

# Debug output
export NEUROLINK_DEBUG=true
npx @juspay/neurolink generate "Test" --debug

Report Issues

When reporting issues, please include:

System Information:

node --version
npm --version
npm list @juspay/neurolink

Debug Output:

export NEUROLINK_DEBUG=true
npx @juspay/neurolink status --verbose

Error Logs: Full error messages and stack traces
Steps to Reproduce: Exact commands that cause the issue

Community Support

GitHub Issues: https://github.com/juspay/neurolink/issues
Documentation: https://github.com/juspay/neurolink/docs

🏢 Enterprise Proxy Issues

Proxy Not Working

Symptoms: Connection errors when HTTPS_PROXY is set

Diagnosis:

# Check proxy environment variables
echo $HTTPS_PROXY
echo $HTTP_PROXY

# Test proxy connectivity
curl -I --proxy $HTTPS_PROXY https://api.openai.com

Solutions:

Verify proxy format:

# Correct format
export HTTPS_PROXY="http://proxy.company.com:8080"

# Not: https:// (use http:// even for HTTPS_PROXY)

Check authentication:

# URL encode special characters
export HTTPS_PROXY="http://user%40domain.com:pass%3Aword@proxy:8080"

Test bypass:

# Temporarily unset proxy
unset HTTPS_PROXY HTTP_PROXY
npx @juspay/neurolink generate "test direct connection"

Corporate Firewall Blocking

Symptoms: Network timeouts or SSL certificate errors

Solutions:

Contact IT team for allowlist:
- generativelanguage.googleapis.com (Google AI)
- api.anthropic.com (Anthropic)
- api.openai.com (OpenAI)
- bedrock.amazonaws.com (Bedrock)
- aiplatform.googleapis.com (Vertex AI)

Check SSL verification:

# Disable SSL verification (not recommended for production)
export NODE_TLS_REJECT_UNAUTHORIZED=0

Debug Proxy Connection

# Enable detailed proxy logging
export DEBUG=neurolink:proxy
npx @juspay/neurolink generate "test proxy" --debug

For detailed proxy setup → See Enterprise & Proxy Setup Guide

📚 Additional Resources

MCP Integration Guide - Complete MCP setup and usage
CLI Guide - Comprehensive CLI documentation
API Reference - Complete API documentation
Configuration Guide - Environment and setup guide

💡 Most issues are resolved by ensuring you're using v1.7.1+ and running npm run build after installation.

FilesExpand file tree

troubleshooting.md

Latest commit

History

troubleshooting.md

File metadata and controls

🚨 NeuroLink Troubleshooting Guide

✅ IMPLEMENTATION STATUS: COMPLETE (2025-01-07)

📖 Overview

🎯 Generate Function Migration Issues

Migration Questions

Migration Examples

CLI Migration

🔧 MCP Integration Issues

✅ Built-in Tools Not Working

🏗️ Configuration Management Issues (NEW v3.0)

Config Update Failures

Backup System Issues

Provider Configuration Issues

🔧 TypeScript Compilation Issues (NEW v3.0)

Build Failures

Interface Compatibility Issues

⚡ Performance Issues (NEW v3.0)

Slow Tool Execution

Pipeline Performance

🔄 Interface Migration Issues (NEW v3.0)

Property Name Errors

Method Call Issues

Generic Type Issues

🛡️ Error Recovery (NEW v3.0)

Automatic Recovery

Manual Recovery

🔍 External MCP Server Discovery Issues

🔧 External MCP Server Activation Issues

🤖 AI Provider Issues

Provider Authentication Errors

Provider Selection Issues

🖥️ CLI Issues

Command Not Found

Build Issues

Model Parameter Not Working

🧪 Testing and Validation

Comprehensive System Test

Debug Mode

📊 System Requirements

Minimum Requirements

Recommended Setup

🆘 Getting Help

Quick Diagnostics

Report Issues

Community Support

🏢 Enterprise Proxy Issues

Proxy Not Working

Corporate Firewall Blocking

Debug Proxy Connection

📚 Additional Resources