salesflare-mcp-server 1.0.0

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "salesflare-mcp-server",
+  "version": "1.0.0",
+  "description": "MCP Server for Salesflare CRM - enables LLMs to interact with Salesflare API",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "salesflare-mcp": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "start": "node ./dist/index.js",
+    "test": "jest",
+    "test:integration": "jest --config jest.integration.config.js",
+    "inspector": "npx @modelcontextprotocol/inspector node ./dist/index.js"
+  },
+  "keywords": [
+    "mcp",
+    "salesflare",
+    "crm",
+    "model-context-protocol"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "axios": "^1.6.0",
+    "cors": "^2.8.6",
+    "dotenv": "^17.4.2",
+    "express": "^5.2.1",
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.6",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "@types/supertest": "^7.2.0",
+    "jest": "^29.0.0",
+    "supertest": "^7.2.2",
+    "ts-jest": "^29.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/test-tasks-debug.js

@@ -0,0 +1,21 @@
+import { createSalesflareClient } from './dist/client/salesflare-client.js';
+import { createApiKeyAuth } from './dist/auth/api-key-auth.js';
+
+const auth = createApiKeyAuth();
+const client = createSalesflareClient({ authProvider: auth });
+
+console.log('Testing tasks endpoint without pagination...\n');
+
+try {
+  const response = await client.get('/tasks');
+  console.log('✅ Success! Response type:', typeof response);
+  console.log('Is array?', Array.isArray(response));
+  console.log('Has items?', response.items !== undefined);
+  if (response.items) {
+    console.log('Items count:', response.items.length);
+  }
+  console.log('\nFull response (first 500 chars):');
+  console.log(JSON.stringify(response, null, 2).substring(0, 500));
+} catch (error) {
+  console.log('❌ Error:', error.message);
+}

package/test-tasks-params.js

@@ -0,0 +1,52 @@
+import { createSalesflareClient } from './dist/client/salesflare-client.js';
+import { createApiKeyAuth } from './dist/auth/api-key-auth.js';
+
+const auth = createApiKeyAuth();
+const client = createSalesflareClient({ authProvider: auth });
+
+console.log('Testing tasks endpoint with various parameters...\n');
+
+// Test 1: No params
+console.log('Test 1: No params');
+try {
+  const response = await client.get('/tasks');
+  console.log('✅ Success - Got', Array.isArray(response) ? response.length : 'non-array', 'items\n');
+} catch (error) {
+  console.log('❌ Error:', error.message, '\n');
+}
+
+// Test 2: With limit
+console.log('Test 2: With limit=5');
+try {
+  const response = await client.get('/tasks', { params: { limit: 5 } });
+  console.log('✅ Success - Got', Array.isArray(response) ? response.length : 'non-array', 'items\n');
+} catch (error) {
+  console.log('❌ Error:', error.message, '\n');
+}
+
+// Test 3: With page
+console.log('Test 3: With page=1');
+try {
+  const response = await client.get('/tasks', { params: { page: 1 } });
+  console.log('✅ Success\n');
+} catch (error) {
+  console.log('❌ Error:', error.message, '\n');
+}
+
+// Test 4: With status
+console.log('Test 4: With status=open');
+try {
+  const response = await client.get('/tasks', { params: { status: 'open' } });
+  console.log('✅ Success\n');
+} catch (error) {
+  console.log('❌ Error:', error.message, '\n');
+}
+
+// Test 5: With completed
+console.log('Test 5: With completed=false');
+try {
+  const response = await client.get('/tasks', { params: { completed: false } });
+  console.log('✅ Success - Got', Array.isArray(response) ? response.length : 'non-array', 'items\n');
+} catch (error) {
+  console.log('❌ Error:', error.message, '\n');
+}

package/test-tools.js

@@ -0,0 +1,171 @@
+/**
+ * Systematic tool testing script
+ * Tests each MCP tool against the real Salesflare API and documents results
+ */
+
+import { createSalesflareClient } from './dist/client/salesflare-client.js';
+import { createApiKeyAuth } from './dist/auth/api-key-auth.js';
+import { handleContactsTool } from './dist/tools/contacts.js';
+import { handleCompaniesTool } from './dist/tools/companies.js';
+import { handleDealsTool } from './dist/tools/deals.js';
+import { handleTasksTool } from './dist/tools/tasks.js';
+import { handlePipelineTool } from './dist/tools/pipeline.js';
+import { SalesflareError } from './dist/utils/errors.js';
+
+// Test results storage
+const results = {
+  passed: [],
+  failed: [],
+  errors: []
+};
+
+// Helper to run a test
+async function runTest(category, toolName, args, handler, client) {
+  console.log(`\n🧪 Testing: ${toolName}`);
+  console.log(`   Args: ${JSON.stringify(args)}`);
+  
+  try {
+    const result = await handler(client, toolName, args);
+    
+    // Check if result has error
+    if (result.content[0].text.includes('Error [')) {
+      results.failed.push({ tool: toolName, args, error: result.content[0].text });
+      console.log(`   ❌ FAILED: ${result.content[0].text.substring(0, 100)}...`);
+    } else {
+      results.passed.push({ tool: toolName, args, preview: result.content[0].text.substring(0, 100) });
+      console.log(`   ✅ PASSED: ${result.content[0].text.substring(0, 100)}...`);
+    }
+  } catch (error) {
+    const errorMsg = error instanceof SalesflareError ? error.message : String(error);
+    results.failed.push({ tool: toolName, args, error: errorMsg });
+    console.log(`   ❌ ERROR: ${errorMsg.substring(0, 100)}...`);
+  }
+}
+
+async function runAllTests() {
+  console.log('═══════════════════════════════════════════════════════');
+  console.log('  SALESFLARE MCP SERVER - AUTOMATED TOOL TESTING');
+  console.log('═══════════════════════════════════════════════════════');
+  console.log(`\nAPI Key: ${process.env.SALESFLARE_API_KEY ? '✓ Set' : '✗ Missing'}`);
+  
+  if (!process.env.SALESFLARE_API_KEY) {
+    console.error('❌ SALESFLARE_API_KEY environment variable is required');
+    process.exit(1);
+  }
+
+  // Create client
+  const auth = createApiKeyAuth();
+  const client = createSalesflareClient({ authProvider: auth });
+
+  // CONTACTS TESTS
+  console.log('\n\n📋 CONTACTS TOOLS');
+  console.log('───────────────────────────────────────────────────────');
+  
+  await runTest('contacts', 'salesflare_contacts_list', {}, handleContactsTool, client);
+  await runTest('contacts', 'salesflare_contacts_list', { limit: 5 }, handleContactsTool, client);
+  await runTest('contacts', 'salesflare_contacts_list', { email: 'test@example.com' }, handleContactsTool, client);
+  
+  await runTest('contacts', 'salesflare_contacts_create', {
+    email: 'mcp-test-' + Date.now() + '@example.com',
+    name: 'MCP Test Contact'
+  }, handleContactsTool, client);
+
+  // COMPANIES TESTS
+  console.log('\n\n🏢 COMPANIES TOOLS');
+  console.log('───────────────────────────────────────────────────────');
+  
+  await runTest('companies', 'salesflare_companies_list', {}, handleCompaniesTool, client);
+  await runTest('companies', 'salesflare_companies_list', { limit: 5 }, handleCompaniesTool, client);
+  await runTest('companies', 'salesflare_companies_list', { name: 'Test' }, handleCompaniesTool, client);
+  
+  await runTest('companies', 'salesflare_companies_create', {
+    name: 'MCP Test Company ' + Date.now()
+  }, handleCompaniesTool, client);
+
+  // DEALS TESTS
+  console.log('\n\n💼 DEALS TOOLS');
+  console.log('───────────────────────────────────────────────────────');
+  
+  await runTest('deals', 'salesflare_deals_list', {}, handleDealsTool, client);
+  await runTest('deals', 'salesflare_deals_list', { limit: 5 }, handleDealsTool, client);
+  await runTest('deals', 'salesflare_deals_list', { status: 'open' }, handleDealsTool, client);
+
+  // TASKS TESTS
+  console.log('\n\n✅ TASKS TOOLS');
+  console.log('───────────────────────────────────────────────────────');
+  
+  await runTest('tasks', 'salesflare_tasks_list', {}, handleTasksTool, client);
+  await runTest('tasks', 'salesflare_tasks_list', { limit: 5 }, handleTasksTool, client);
+  await runTest('tasks', 'salesflare_tasks_list', { status: 'open' }, handleTasksTool, client);
+  
+  await runTest('tasks', 'salesflare_tasks_create', {
+    description: 'MCP Test Task ' + Date.now()
+  }, handleTasksTool, client);
+
+  // PIPELINE TESTS
+  console.log('\n\n🔄 PIPELINE TOOLS');
+  console.log('───────────────────────────────────────────────────────');
+  
+  await runTest('pipeline', 'salesflare_pipeline_list_stages', {}, handlePipelineTool, client);
+  await runTest('pipeline', 'salesflare_pipeline_get_overview', {}, handlePipelineTool, client);
+
+  // SUMMARY
+  console.log('\n\n═══════════════════════════════════════════════════════');
+  console.log('  TEST RESULTS SUMMARY');
+  console.log('═══════════════════════════════════════════════════════');
+  console.log(`\n✅ Passed: ${results.passed.length}`);
+  console.log(`❌ Failed: ${results.failed.length}`);
+  console.log(`\n📊 Success Rate: ${((results.passed.length / (results.passed.length + results.failed.length)) * 100).toFixed(1)}%`);
+
+  if (results.failed.length > 0) {
+    console.log('\n\n🔴 FAILED TESTS DETAILS:');
+    console.log('───────────────────────────────────────────────────────');
+    results.failed.forEach((fail, idx) => {
+      console.log(`\n${idx + 1}. ${fail.tool}`);
+      console.log(`   Args: ${JSON.stringify(fail.args)}`);
+      console.log(`   Error: ${fail.error}`);
+    });
+  }
+
+  // Generate fix plan
+  console.log('\n\n═══════════════════════════════════════════════════════');
+  console.log('  RECOMMENDED FIX PLAN');
+  console.log('═══════════════════════════════════════════════════════');
+  
+  const errorTypes = {};
+  results.failed.forEach(fail => {
+    const errorKey = fail.error.includes('NOT_FOUND') ? 'NOT_FOUND' :
+                     fail.error.includes('VALIDATION_ERROR') ? 'VALIDATION_ERROR' :
+                     fail.error.includes('AUTH') ? 'AUTH_ERROR' :
+                     fail.error.includes('API_ERROR') ? 'API_ERROR' :
+                     'OTHER';
+    if (!errorTypes[errorKey]) errorTypes[errorKey] = [];
+    errorTypes[errorKey].push(fail.tool);
+  });
+
+  Object.entries(errorTypes).forEach(([type, tools]) => {
+    console.log(`\n${type} (${tools.length} tools):`);
+    console.log(`  Affected: ${tools.join(', ')}`);
+    
+    switch(type) {
+      case 'NOT_FOUND':
+        console.log(`  Fix: Check if endpoint URLs are correct`);
+        break;
+      case 'VALIDATION_ERROR':
+        console.log(`  Fix: Review required fields and validation logic`);
+        break;
+      case 'AUTH_ERROR':
+        console.log(`  Fix: Verify API key permissions`);
+        break;
+      case 'API_ERROR':
+        console.log(`  Fix: Check API response format handling`);
+        break;
+      default:
+        console.log(`  Fix: Review tool implementation`);
+    }
+  });
+
+  console.log('\n');
+}
+
+runAllTests().catch(console.error);